slideshow/source/inc/animationactivity.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_ANIMATIONACTIVITY_HXX
  21 #define INCLUDED_SLIDESHOW_ANIMATIONACTIVITY_HXX
  22
  23 #include "activity.hxx"
  24 #include "animatableshape.hxx"
  25 #include "shapeattributelayer.hxx"
  26
  27
  28 /* Definition of AnimationActivity interface */
  29
  30 namespace slideshow
  31 {
  32     namespace internal
  33     {
  34
  35         /** Extends the Activity interface with animation-specific functions
  36          */
  37         class AnimationActivity : public Activity
  38         {
  39         public:
  40             /** Sets targets (shape and attributeLayer)
  41
  42                 Since attribute layers can only be generated when the
  43                 animation starts, the Activity owner must be able to
  44                 pass it into the Activity after initial creation. The
  45                 same applies to the actual shape the animation must
  46                 run for, since e.g. subsetted shapes are generated
  47                 close before the animation starts, too (this is not
  48                 necessary in and out of itself, but for performance
  49                 reasons. Otherwise, character iterations produce tons
  50                 of subset shapes).
  51
  52                 @param rShape
  53                 Shape to play the animation on.
  54
  55                 @param rAttrLayer
  56                 Attribute layer to change the animated values on.
  57              */
  58             virtual void setTargets( const AnimatableShapeSharedPtr&        rShape,
  59                                      const ShapeAttributeLayerSharedPtr&    rAttrLayer ) = 0;
  60         };
  61
  62         typedef ::boost::shared_ptr< AnimationActivity > AnimationActivitySharedPtr;
  63
  64     }
  65 }
  66
  67 #endif /* INCLUDED_SLIDESHOW_ANIMATIONACTIVITY_HXX */
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */