1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <deque> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include "activity.hxx" 30*b1cdbd2cSJim Jagielski #include "unoviewcontainer.hxx" 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include <canvas/elapsedtime.hxx> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 35*b1cdbd2cSJim Jagielski #include <boost/utility.hpp> // for boost::noncopyable 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski /* Definition of ActivitiesQueue class */ 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski namespace slideshow 41*b1cdbd2cSJim Jagielski { 42*b1cdbd2cSJim Jagielski namespace internal 43*b1cdbd2cSJim Jagielski { 44*b1cdbd2cSJim Jagielski /** This class handles the XSprite updates needed for 45*b1cdbd2cSJim Jagielski animations, such as moves, scales etc. You can add 46*b1cdbd2cSJim Jagielski activity objects to this class, which are called in a 47*b1cdbd2cSJim Jagielski round-robin fashion. 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski class ActivitiesQueue : private ::boost::noncopyable 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski public: 52*b1cdbd2cSJim Jagielski /** Create an ActivitiesQueue. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski @param pPresTimer 55*b1cdbd2cSJim Jagielski Pointer to global presentation timer. Used for 56*b1cdbd2cSJim Jagielski adjusting and holding global presentation time. 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielski ActivitiesQueue( 59*b1cdbd2cSJim Jagielski const ::boost::shared_ptr< ::canvas::tools::ElapsedTime >& pPresTimer ); 60*b1cdbd2cSJim Jagielski ~ActivitiesQueue(); 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** Add the given activity to the queue. 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski bool addActivity( const ActivitySharedPtr& pActivity ); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** Process the activities queue. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski This method performs the smallest atomic processing 69*b1cdbd2cSJim Jagielski possible on the queue (typically, this means one 70*b1cdbd2cSJim Jagielski activity get processed). 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski void process(); 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** Call all dequeued activities' dequeued() method 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski void processDequeued(); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** Query state of the queue 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @return false, if queue is empty, true otherwise 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski bool isEmpty() const; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** Remove all pending activities from the queue. 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski void clear(); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** Gets the queue's timer object. 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski ::boost::shared_ptr< ::canvas::tools::ElapsedTime > const & getTimer() const91*b1cdbd2cSJim Jagielski getTimer() const { return mpTimer; } 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski /** returns number of all activities, waiting, reinserted and dequeued 94*b1cdbd2cSJim Jagielski */ size() const95*b1cdbd2cSJim Jagielski std::size_t size() const 96*b1cdbd2cSJim Jagielski { 97*b1cdbd2cSJim Jagielski return maCurrentActivitiesWaiting.size() + maCurrentActivitiesReinsert.size() + maDequeuedActivities.size(); 98*b1cdbd2cSJim Jagielski } 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski private: 101*b1cdbd2cSJim Jagielski ::boost::shared_ptr< ::canvas::tools::ElapsedTime > mpTimer; 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski typedef ::std::deque< ActivitySharedPtr > ActivityQueue; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski ActivityQueue maCurrentActivitiesWaiting; // currently running 106*b1cdbd2cSJim Jagielski // activities, that still 107*b1cdbd2cSJim Jagielski // await processing for this 108*b1cdbd2cSJim Jagielski // round 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski ActivityQueue maCurrentActivitiesReinsert; // currently running 111*b1cdbd2cSJim Jagielski // activities, that are 112*b1cdbd2cSJim Jagielski // already processed for 113*b1cdbd2cSJim Jagielski // this round, and wants 114*b1cdbd2cSJim Jagielski // to be reinserted next 115*b1cdbd2cSJim Jagielski // round 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski ActivityQueue maDequeuedActivities; // This list collects all activities which did not request 118*b1cdbd2cSJim Jagielski // a reinsertion. After the screen update has been 119*b1cdbd2cSJim Jagielski // performed, those are notified via dequeued(). This 120*b1cdbd2cSJim Jagielski // facilitates cleanup actions taking place _after_ the 121*b1cdbd2cSJim Jagielski // current frame has been displayed. 122*b1cdbd2cSJim Jagielski }; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski } 125*b1cdbd2cSJim Jagielski } 126*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_ACTIVITIESQUEUE_HXX */ 127