LibreOffice Module slideshow (master) 1
Public Types | Public Member Functions | List of all members
slideshow::internal::NumberAnimation Class Referenceabstract

Interface defining a number animation. More...

#include <numberanimation.hxx>

Inheritance diagram for slideshow::internal::NumberAnimation:
[legend]
Collaboration diagram for slideshow::internal::NumberAnimation:
[legend]

Public Types

typedef double ValueType
 

Public Member Functions

virtual bool operator() (double x)=0
 Set the animation to value x. More...
 
virtual double getUnderlyingValue () const =0
 Request the underlying value for this animation. More...
 
- Public Member Functions inherited from slideshow::internal::Animation
virtual void prefetch ()=0
 Notify that the animation going active soon. More...
 
virtual void start (const AnimatableShapeSharedPtr &rShape, const ShapeAttributeLayerSharedPtr &rAttrLayer)=0
 Notify that the animation is about to begin. More...
 
virtual void end ()=0
 Notify that the animation is about to end. More...
 
- Public Member Functions inherited from slideshow::internal::SharedPtrAble
virtual ~SharedPtrAble ()
 

Detailed Description

Interface defining a number animation.

This interface is a specialization of the Animation interface, and is used to animate attributes representable by a single floating point value.

Definition at line 36 of file numberanimation.hxx.

Member Typedef Documentation

◆ ValueType

Definition at line 39 of file numberanimation.hxx.

Member Function Documentation

◆ getUnderlyingValue()

virtual double slideshow::internal::NumberAnimation::getUnderlyingValue ( ) const
pure virtual

Request the underlying value for this animation.

This is necessary for pure To or By animations, as the Activity cannot determine a sensible start value otherwise.

Attention: \n Note that you are only permitted to query
for the underlying value, if the animation has actually been started (via start() call).

Implemented in slideshow::internal::SlideChangeBase.

◆ operator()()

virtual bool slideshow::internal::NumberAnimation::operator() ( double  x)
pure virtual

Set the animation to value x.

Parameters
xCurrent animation value (must be in an attribute-specific permissible range). Overflowing values will be clipped to the permissible range internally.

Implemented in slideshow::internal::CombTransition, and slideshow::internal::SlideChangeBase.


The documentation for this class was generated from the following file: