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 <basegfx/vector/b2dvector.hxx>
  25
  26 #include <slideshowcontext.hxx>
  27 #include <animationnode.hxx>
  28
  29 namespace com::sun::star::animations { class XAnimationNode; }
  30
  31
  32 /* Definition of SlideAnimations class */
  33
  34 namespace slideshow::internal
  35     {
  36         /** This class generates and manages all animations of a slide.
  37
  38             Provided with the root animation node, this class imports
  39             the effect information and builds the event tree for all
  40             of the slide's animations.
  41          */
  42         class SlideAnimations
  43         {
  44         public:
  45             /** Create an animation generator.
  46
  47                 @param rContext
  48                 Slide show context, passing on common parameters
  49              */
  50             SlideAnimations( SlideShowContext      aContext,
  51                              const ::basegfx::B2DVector& rSlideSize );
  52             ~SlideAnimations() COVERITY_NOEXCEPT_FALSE;
  53
  54             /** Import animations from a SMIL root animation node.
  55
  56                 This method might take some time, depending on the
  57                 complexity of the SMIL animation network to be
  58                 imported.
  59
  60                 @param xRootAnimationNode
  61                 Root animation node for the effects to be
  62                 generated. This is typically obtained from the
  63                 XDrawPage's XAnimationNodeSupplier.
  64
  65              */
  66             bool importAnimations( const css::uno::Reference< css::animations::XAnimationNode >&   xRootAnimationNode );
  67
  68             /** Check, whether imported animations actually contain
  69                 any effects.
  70
  71                 @return true, if there are actual animations in the
  72                 imported node tree.
  73              */
  74             bool isAnimated() const;
  75
  76             /** Start the animations.
  77
  78                 This method creates the network of events and
  79                 activities for all animations. The events and
  80                 activities are inserted into the constructor-provided
  81                 queues. These queues are not explicitly cleared, if
  82                 you rely on this object's effects to run without
  83                 interference, you should clear the queues by yourself.
  84
  85                 @return true, if all events have been successfully
  86                 created.
  87              */
  88             bool start();
  89
  90             /** End all animations.
  91
  92                 This method force-ends all animations. If a slide end
  93                 event has been registered, that is fired, too.
  94              */
  95             void end();
  96
  97         private:
  98             SlideShowContext         maContext;
  99             const basegfx::B2DVector maSlideSize;
 100             AnimationNodeSharedPtr   mpRootNode;
 101         };
 102
 103 }
 104
 105 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_SLIDEANIMATIONS_HXX
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */