Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Named property class. More...
#include <ilviews/util/animator.h>
Public Member Functions | |
IlvGraphicAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100, IlBoolean useApply=IlTrue) | |
Constructor. More... | |
void | addTo (IlvGraphic *graphic) |
Connects the animator with a given graphic object. More... | |
virtual void | animate () |
Called to animate the animator. More... | |
IlvGraphic * | getGraphic () const |
Returns the graphic object connected with the animator. More... | |
virtual void | initReDraws () const |
Called to begin a redraw session. More... | |
virtual void | invalidateRegion () const |
Called to invalidate the area affected by the animator. More... | |
virtual void | reDrawViews () const |
Called to finish a redraw session. More... | |
void | removeFrom (IlvGraphic *graphic) |
Disconnects the animator from the given graphic object. More... | |
virtual void | stateChanged (IlUInt newState, IlUInt oldState) |
Called by IlvAnimator::changeState each time the animator state changes. More... | |
void | useApply (IlBoolean value) |
Specifies to the animator whether to use "applyTo" functions. More... | |
IlBoolean | usesApply () const |
Returns a Boolean indicating whether the animator will use "applyToObject" functions. More... | |
Public Member Functions inherited from IlvAnimator | |
IlvAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100) | |
Constructor. More... | |
void | changeState (IlUInt state, IlBoolean redraw=IlTrue) |
Changes the animator state. More... | |
IlvAnimationMode | getAnimationMode () const |
Returns the animation mode of the animator. More... | |
IlUInt | getPeriod () const |
Returns the animation period of the animator. More... | |
IlUInt | getState () const |
Returns the animator state. More... | |
virtual IlUInt | getStatesCount () const =0 |
Returns the number of states of the animator. More... | |
virtual IlBoolean | isLastState (IlUInt state) const |
Returns a Boolean value indicating whether the specified state is the last one. More... | |
virtual IlUInt | nextState (IlUInt state) const |
Returns the animator state that must be set after a given state. More... | |
virtual void | reDraw () const |
Called to redraw the animator. More... | |
void | setAnimationMode (IlvAnimationMode mode) |
Sets the animation mode of the animator. More... | |
void | setAnimationMode (IlvAnimationMode mode, IlUInt period) |
Sets the animation mode and the period of the animator. More... | |
void | setState (IlUInt state) |
Sets the animator state. More... | |
Public Member Functions inherited from IlvNamedProperty | |
IlvNamedProperty (IlSymbol *) | |
Constructor. More... | |
IlvNamedProperty (const IlvNamedProperty &source) | |
Constructor. More... | |
IlvNamedProperty * | copy () const =0 |
Copies the property. More... | |
const char * | getName () const |
Gets the name of the property. More... | |
IlSymbol * | getSymbol () const |
Gets the name of the property. More... | |
virtual IlBoolean | isPersistent () const |
Specifies whether the property must save itself. More... | |
void | write (IlvOutputFile &stream) const =0 |
Saves the description of the property. More... | |
Public Member Functions inherited from IlvValueInterface | |
virtual IlBoolean | applyValue (const IlvValue &value) |
Apply an accessor. More... | |
virtual IlBoolean | changeValue (const IlvValue &val) |
Changes the value of an accessor. More... | |
virtual IlBoolean | changeValues (const IlvValue *values, IlUShort count=0) |
Changes several accessor values simultaneously. More... | |
virtual void | getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const |
Retrieves the list of available accessors of an object. More... | |
virtual IlvValue & | queryValue (IlvValue &val) const |
Retrieves an accessor value. More... | |
virtual void | queryValues (IlvValue *values, IlUShort count) const |
Retrieves multiple accessor values simultaneously. More... | |
Static Public Member Functions | |
static IlvGraphicAnimator * | Get (const IlvGraphic *graphic, const IlSymbol *name) |
Returns the animator connected with a graphic object given its name. More... | |
static IlvGraphicAnimator * | RemoveFrom (IlvGraphic *graphic, const IlSymbol *name) |
Removes the menu item group from the specified abstract menu. More... | |
Additional Inherited Members | |
Public Types inherited from IlvAnimator | |
Public Attributes inherited from IlvNamedProperty | |
IlvNamedProperty *IlvInputFile & | stream |
Reads an instance of the property class. More... | |
Named property class.
Library: views
IlvGraphicAnimator
is a subclass of IlvAnimator
that deals with animation of IlvGraphic
objects.
IlvBitmapAnimator
IlvGraphicAnimator::IlvGraphicAnimator | ( | IlSymbol * | name, |
IlvAnimationMode | mode = IlvAnimationForward , |
||
IlUInt | period = 100 , |
||
IlBoolean | useApply = IlTrue |
||
) |
Constructor.
Initializes a new instance of the IlvGraphicAnimator
class. The animator will start when it is connected to any object.
name | The animator name. |
mode | The animation mode. |
period | The animator period. |
useApply | A Boolean value specifying whether the animator will use "applyToObject" functions. |
void IlvGraphicAnimator::addTo | ( | IlvGraphic * | graphic | ) |
Connects the animator with a given graphic object.
Does nothing if the graphic object already has a named property with the same symbol as this.
graphic | The graphic object. |
GetAnimator()
, removeFrom()
|
virtual |
Called to animate the animator.
The default implementation calls IlvAnimator::changeState
with the result of IlvAnimator::nextState
as new state, and with redraw set to IlTrue
.
getState()
, nextState()
, setState()
, changeState()
Reimplemented from IlvAnimator.
|
static |
Returns the animator connected with a graphic object given its name.
graphic | The graphic object. |
name | The animator name. |
addTo()
, removeFrom()
IlvGraphic* IlvGraphicAnimator::getGraphic | ( | ) | const |
Returns the graphic object connected with the animator.
|
virtual |
Called to begin a redraw session.
You must redefine this method in a subclass.
reDraw()
, invalidateRegion()
, reDrawViews()
Implements IlvAnimator.
|
virtual |
Called to invalidate the area affected by the animator.
You must redefine this method in a subclass.
reDraw()
, initReDraws()
, reDrawViews()
Implements IlvAnimator.
|
virtual |
Called to finish a redraw session.
You must redefine this method in a subclass.
reDraw()
, initReDraws()
, invalidateRegion()
Implements IlvAnimator.
void IlvGraphicAnimator::removeFrom | ( | IlvGraphic * | graphic | ) |
Disconnects the animator from the given graphic object.
graphic | The graphic object. |
GetAnimator()
, addTo()
|
static |
Called by IlvAnimator::changeState
each time the animator state changes.
The default implementation does nothing.
newState | The new animator state. |
oldState | The previous animator state. |
getState()
, nextState()
, changeState()
Reimplemented from IlvAnimator.
void IlvGraphicAnimator::useApply | ( | IlBoolean | value | ) |
Specifies to the animator whether to use "applyTo" functions.
See the description of IlvAnimator::useApply
for more details.
IlBoolean IlvGraphicAnimator::usesApply | ( | ) | const |
Returns a Boolean indicating whether the animator will use "applyToObject" functions.
The default value for this setting is IlTrue
. It means that the animate
call is encapsulated in a call to IlvGraphicHolder::applyToObject
. This makes it possible to move the graphic object encapsulated in this animator without calling applyToObject
yourself. However, if you know that the animator will not move the object, you can disable this feature to improve performance.
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.