1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: numberanimation.hxx,v $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef INCLUDED_SLIDESHOW_NUMBERANIMATION_HXX
32 #define INCLUDED_SLIDESHOW_NUMBERANIMATION_HXX
34 #include <animation.hxx>
37 /* Definition of NumberAnimation interface */
43 /** Interface defining a number animation.
45 This interface is a specialization of the Animation
46 interface, and is used to animate attributes representable
47 by a single floating point value.
49 class NumberAnimation
: public Animation
52 typedef double ValueType
;
54 /** Set the animation to value x
57 Current animation value (must be in an
58 attribute-specific permissible range). Overflowing
59 values will be clipped to the permissible range
62 virtual bool operator()( ValueType x
) = 0;
64 /** Request the underlying value for this animation.
66 This is necessary for pure To or By animations, as the
67 Activity cannot determine a sensible start value
70 @attention Note that you are only permitted to query
71 for the underlying value, if the animation has actually
72 been started (via start() call).
74 virtual ValueType
getUnderlyingValue() const = 0;
77 typedef ::boost::shared_ptr
< NumberAnimation
> NumberAnimationSharedPtr
;
82 #endif /* INCLUDED_SLIDESHOW_NUMBERANIMATION_HXX */