Line data    Source code

       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_ANIMATION_HXX
      21             : #define INCLUDED_SLIDESHOW_ANIMATION_HXX
      22             : 
      23             : #include <animatableshape.hxx>
      24             : #include <shapeattributelayer.hxx>
      25             : 
      26             : 
      27             : /* Definition of Animation interface */
      28             : 
      29             : namespace slideshow
      30             : {
      31             :     namespace internal
      32             :     {
      33             :         /** Interface defining a generic animation.
      34             : 
      35             :             This interface is used by objects implementing the
      36             :             Activity interface to drive the animation effect. Objects
      37             :             implementing this interface will receive time-varying
      38             :             animation values, which they can forward to the
      39             :             appropriate attributes. The type of these animation values
      40             :             is given in derived interfaces.
      41             : 
      42             :             @see NumberAnimation
      43             :             @see ColorAnimation
      44             :             @see PairAnimation
      45             :          */
      46           0 :         class Animation
      47             :         {
      48             :         public:
      49           0 :             virtual ~Animation() {}
      50             : 
      51             :             /** Notify that the animation going active soon.
      52             : 
      53             :                 Implementers should preload any buffers, and create
      54             :                 any expensive objects at this time.
      55             : 
      56             :                 @param rShape
      57             :                 Shape to apply this animation to.
      58             : 
      59             :                 @param rAttrLayer
      60             :                 Attribute layer to play the animation on.
      61             :              */
      62             :             virtual void prefetch( const AnimatableShapeSharedPtr&     rShape,
      63             :                                    const ShapeAttributeLayerSharedPtr& rAttrLayer ) = 0;
      64             : 
      65             :             /** Notify that the animation is about to begin.
      66             : 
      67             :                 Implementers are free to start accompanying effects,
      68             :                 such as sounds, and the animation timer now.
      69             : 
      70             :                 @param rShape
      71             :                 Shape to apply this animation to.
      72             : 
      73             :                 @param rAttrLayer
      74             :                 Attribute layer to play the animation on.
      75             :              */
      76             :             virtual void start( const AnimatableShapeSharedPtr&     rShape,
      77             :                                 const ShapeAttributeLayerSharedPtr& rAttrLayer ) = 0;
      78             : 
      79             :             /** Notify that the animation is about to end.
      80             :              */
      81             :             virtual void end() = 0;
      82             :         };
      83             : 
      84             :         typedef ::boost::shared_ptr< Animation > AnimationSharedPtr;
      85             : 
      86             :     }
      87             : }
      88             : 
      89             : #endif /* INCLUDED_SLIDESHOW_ANIMATION_HXX */
      90             : 
      91             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */