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