slideshow/source/engine/slide/slideanimations.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_SLIDEANIMATIONS_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_SLIDEANIMATIONS_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25 #include <basegfx/vector/b2dvector.hxx>
  26
  27 #include "event.hxx"
  28 #include "slideshowcontext.hxx"
  29 #include "subsettableshapemanager.hxx"
  30 #include "animationnode.hxx"
  31
  32 namespace com { namespace sun { namespace star { namespace animations
  33 {
  34     class XAnimationNode;
  35 } } } }
  36
  37
  38 /* Definition of SlideAnimations class */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         /** This class generates and manages all animations of a slide.
  45
  46             Provided with the root animation node, this class imports
  47             the effect information and builds the event tree for all
  48             of the slide's animations.
  49          */
  50         class SlideAnimations
  51         {
  52         public:
  53             /** Create an animation generator.
  54
  55                 @param rContext
  56                 Slide show context, passing on common parameters
  57              */
  58             SlideAnimations( const SlideShowContext&     rContext,
  59                              const ::basegfx::B2DVector& rSlideSize );
  60             ~SlideAnimations();
  61
  62             /** Import animations from a SMIL root animation node.
  63
  64                 This method might take some time, depending on the
  65                 complexity of the SMIL animation network to be
  66                 imported.
  67
  68                 @param xRootAnimationNode
  69                 Root animation node for the effects to be
  70                 generated. This is typically obtained from the
  71                 XDrawPage's XAnimationNodeSupplier.
  72
  73              */
  74             bool importAnimations( const ::com::sun::star::uno::Reference<
  75                                       ::com::sun::star::animations::XAnimationNode >&   xRootAnimationNode );
  76
  77             /** Check, whether imported animations actually contain
  78                 any effects.
  79
  80                 @return true, if there are actual animations in the
  81                 imported node tree.
  82              */
  83             bool isAnimated() const;
  84
  85             /** Start the animations.
  86
  87                 This method creates the network of events and
  88                 activities for all animations. The events and
  89                 activities are inserted into the constructor-provided
  90                 queues. These queues are not explicitly cleared, if
  91                 you rely on this object's effects to run without
  92                 interference, you should clear the queues by yourself.
  93
  94                 @return true, if all events have been successfully
  95                 created.
  96              */
  97             bool start();
  98
  99             /** End all animations.
 100
 101                 This method force-ends all animations. If a slide end
 102                 event has been registered, that is fired, too.
 103              */
 104             void end();
 105
 106         private:
 107             SlideShowContext         maContext;
 108             const basegfx::B2DVector maSlideSize;
 109             AnimationNodeSharedPtr   mpRootNode;
 110         };
 111     }
 112 }
 113
 114 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_SLIDEANIMATIONS_HXX
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */