Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: rendering ::

interface XAnimation
Description
This interface defines an animation sequence.

This interface must be implemented by every animation object. It is used by the XCanvas interface to render generic animations.

Since
OOo 2.0

Methods' Summary
render Render the animation content at time t into the specified canvas. 
getAnimationAttributes Request the attribute information for this animation. 
Methods' Details
render
void
render( [in] XCanvas  canvas,
[in] ViewState  viewState,
[in] double  t )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Render the animation content at time t into the specified canvas.

Note that it is perfectly legal to e.g. map t in a nonlinear fashion to internal frames, for example to achieve acceleration or decceleration effects. It is required that the render method has const semantics, i.e. when called with the same parameter set, identical output must be generated. This is because e.g. a Sprite might decide arbitrarily to render an animation once and cache the result, or repaint it via XAnimation::render everytime.

The rendered content, although, must be exactly the same for identical viewState, canvas and t values. Or, for that matters, must call the same canvas methods in the same order with the same parameter sets, for identical viewState and t values. Furthermore, when viewState has the identity transformation set, rendered output must be contained in a rectangle with upper left corner at (0,0) and width and height given by the AnimationAttributes' untransformedSize member. Any content exceeding this box might get clipped off.

Parameter canvas
The target canvas to render this animation to.
Parameter viewState
The view state to be used when rendering this animation to the target canvas. The view transformation matrix must not be singular.
Parameter t
Time instant for which animation content is requested. The range must always be [0,1], where 0 denotes the very beginning, and 1 the end of the animation sequence.
Throws
com::sun::star::lang::IllegalArgumentException if one of the passed parameters does not lie in the specified, permissible range.
getAnimationAttributes
AnimationAttributes
getAnimationAttributes();

Description
Request the attribute information for this animation.

This method returns the AnimationAttributes structure, which defines more closely how to play this animation.

Returns
the requested AnimationAttributes structure.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.