slideshow/source/inc/animationfunction.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: animationfunction.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_ANIMATIONFUNCTION_HXX
  32 #define INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
  33
  34 #include <sal/config.h>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 /* Definition of AnimationFunction interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         /** Interface describing an abstract animation function.
  45
  46             Use this interface to model time-dependent animation
  47             functions of one variable.
  48          */
  49         class AnimationFunction
  50         {
  51         public:
  52             virtual ~AnimationFunction() {}
  53
  54             /** Operator to calculate function value.
  55
  56                 This method calculates the function value for the
  57                 given time instant t.
  58
  59                 @param t
  60                 Current time instant, must be in the range [0,1]
  61
  62                 @return the function value, typically in relative
  63                 user coordinate space ([0,1] range).
  64              */
  65             virtual double operator()( double t ) const = 0;
  66
  67         };
  68
  69         typedef ::boost::shared_ptr< AnimationFunction > AnimationFunctionSharedPtr;
  70
  71     }
  72 }
  73
  74 #endif /* INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX */