| /************************************************************** | |
| * | |
| * Licensed to the Apache Software Foundation (ASF) under one | |
| * or more contributor license agreements. See the NOTICE file | |
| * distributed with this work for additional information | |
| * regarding copyright ownership. The ASF licenses this file | |
| * to you under the Apache License, Version 2.0 (the | |
| * "License"); you may not use this file except in compliance | |
| * with the License. You may obtain a copy of the License at | |
| * | |
| * http://www.apache.org/licenses/LICENSE-2.0 | |
| * | |
| * Unless required by applicable law or agreed to in writing, | |
| * software distributed under the License is distributed on an | |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| * KIND, either express or implied. See the License for the | |
| * specific language governing permissions and limitations | |
| * under the License. | |
| * | |
| *************************************************************/ | |
| #ifndef INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX | |
| #define INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX | |
| #include <deque> | |
| #include "activity.hxx" | |
| #include "unoviewcontainer.hxx" | |
| #include <canvas/elapsedtime.hxx> | |
| #include <boost/shared_ptr.hpp> | |
| #include <boost/utility.hpp> // for boost::noncopyable | |
| /* Definition of ActivitiesQueue class */ | |
| namespace slideshow | |
| { | |
| namespace internal | |
| { | |
| /** This class handles the XSprite updates needed for | |
| animations, such as moves, scales etc. You can add | |
| activity objects to this class, which are called in a | |
| round-robin fashion. | |
| */ | |
| class ActivitiesQueue : private ::boost::noncopyable | |
| { | |
| public: | |
| /** Create an ActivitiesQueue. | |
| @param pPresTimer | |
| Pointer to global presentation timer. Used for | |
| adjusting and holding global presentation time. | |
| */ | |
| ActivitiesQueue( | |
| const ::boost::shared_ptr< ::canvas::tools::ElapsedTime >& pPresTimer ); | |
| ~ActivitiesQueue(); | |
| /** Add the given activity to the queue. | |
| */ | |
| bool addActivity( const ActivitySharedPtr& pActivity ); | |
| /** Process the activities queue. | |
| This method performs the smallest atomic processing | |
| possible on the queue (typically, this means one | |
| activity get processed). | |
| */ | |
| void process(); | |
| /** Call all dequeued activities' dequeued() method | |
| */ | |
| void processDequeued(); | |
| /** Query state of the queue | |
| @return false, if queue is empty, true otherwise | |
| */ | |
| bool isEmpty() const; | |
| /** Remove all pending activities from the queue. | |
| */ | |
| void clear(); | |
| /** Gets the queue's timer object. | |
| */ | |
| ::boost::shared_ptr< ::canvas::tools::ElapsedTime > const & | |
| getTimer() const { return mpTimer; } | |
| /** returns number of all activities, waiting, reinserted and dequeued | |
| */ | |
| std::size_t size() const | |
| { | |
| return maCurrentActivitiesWaiting.size() + maCurrentActivitiesReinsert.size() + maDequeuedActivities.size(); | |
| } | |
| private: | |
| ::boost::shared_ptr< ::canvas::tools::ElapsedTime > mpTimer; | |
| typedef ::std::deque< ActivitySharedPtr > ActivityQueue; | |
| ActivityQueue maCurrentActivitiesWaiting; // currently running | |
| // activities, that still | |
| // await processing for this | |
| // round | |
| ActivityQueue maCurrentActivitiesReinsert; // currently running | |
| // activities, that are | |
| // already processed for | |
| // this round, and wants | |
| // to be reinserted next | |
| // round | |
| ActivityQueue maDequeuedActivities; // This list collects all activities which did not request | |
| // a reinsertion. After the screen update has been | |
| // performed, those are notified via dequeued(). This | |
| // facilitates cleanup actions taking place _after_ the | |
| // current frame has been displayed. | |
| }; | |
| } | |
| } | |
| #endif /* INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX */ |