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