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