office-gobmx/slideshow/source/inc/animationfunction.hxx
2010-10-28 15:50:10 +01:00

74 lines
2.4 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
#define INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX
#include <sal/config.h>
#include <boost/shared_ptr.hpp>
/* Definition of AnimationFunction interface */
namespace slideshow
{
namespace internal
{
/** Interface describing an abstract animation function.
Use this interface to model time-dependent animation
functions of one variable.
*/
class AnimationFunction
{
public:
virtual ~AnimationFunction() {}
/** Operator to calculate function value.
This method calculates the function value for the
given time instant t.
@param t
Current time instant, must be in the range [0,1]
@return the function value, typically in relative
user coordinate space ([0,1] range).
*/
virtual double operator()( double t ) const = 0;
};
typedef ::boost::shared_ptr< AnimationFunction > AnimationFunctionSharedPtr;
}
}
#endif /* INCLUDED_SLIDESHOW_ANIMATIONFUNCTION_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */