slideshow/source/engine/slide/slideanimations.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: slideanimations.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_SLIDEANIMATIONS_HXX
  32 #define INCLUDED_SLIDESHOW_SLIDEANIMATIONS_HXX
  33
  34 #include <com/sun/star/uno/Reference.hxx>
  35 #include <com/sun/star/uno/XComponentContext.hpp>
  36 #include <basegfx/vector/b2dvector.hxx>
  37
  38 #include "event.hxx"
  39 #include "slideshowcontext.hxx"
  40 #include "subsettableshapemanager.hxx"
  41 #include "animationnode.hxx"
  42
  43 namespace com { namespace sun { namespace star { namespace animations
  44 {
  45     class XAnimationNode;
  46 } } } }
  47
  48
  49 /* Definition of SlideAnimations class */
  50
  51 namespace slideshow
  52 {
  53     namespace internal
  54     {
  55         /** This class generates and manages all animations of a slide.
  56
  57             Provided with the root animation node, this class imports
  58             the effect information and builds the event tree for all
  59             of the slide's animations.
  60          */
  61         class SlideAnimations
  62         {
  63         public:
  64             /** Create an animation generator.
  65
  66                 @param rContext
  67                 Slide show context, passing on common parameters
  68              */
  69             SlideAnimations( const SlideShowContext&     rContext,
  70                              const ::basegfx::B2DVector& rSlideSize );
  71             ~SlideAnimations();
  72
  73             /** Import animations from a SMIL root animation node.
  74
  75                 This method might take some time, depending on the
  76                 complexity of the SMIL animation network to be
  77                 imported.
  78
  79                 @param xRootAnimationNode
  80                 Root animation node for the effects to be
  81                 generated. This is typically obtained from the
  82                 XDrawPage's XAnimationNodeSupplier.
  83
  84              */
  85             bool importAnimations( const ::com::sun::star::uno::Reference<
  86                                       ::com::sun::star::animations::XAnimationNode >&   xRootAnimationNode );
  87
  88             /** Check, whether imported animations actually contain
  89                 any effects.
  90
  91                 @return true, if there are actual animations in the
  92                 imported node tree.
  93              */
  94             bool isAnimated() const;
  95
  96             /** Start the animations.
  97
  98                 This method creates the network of events and
  99                 activities for all animations. The events and
 100                 activities are inserted into the constructor-provided
 101                 queues. These queues are not explicitely cleared, if
 102                 you rely on this object's effects to run without
 103                 interference, you should clear the queues by yourself.
 104
 105                 @return true, if all events have been successfully
 106                 created.
 107              */
 108             bool start();
 109
 110             /** End all animations.
 111
 112                 This method force-ends all animations. If a slide end
 113                 event has been registered, that is fired, too.
 114              */
 115             void end();
 116
 117             /// Release all references. Does not notify anything.
 118             void dispose();
 119
 120         private:
 121             SlideShowContext             maContext;
 122             const basegfx::B2DVector maSlideSize;
 123             AnimationNodeSharedPtr   mpRootNode;
 124         };
 125     }
 126 }
 127
 128 #endif /* INCLUDED_SLIDESHOW_SLIDEANIMATIONS_HXX */