Rogue Wave Views 5.5.1 |
Rogue Wave Views |
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=((IlBoolean) 1)) | |
Constructor. | |
void | addTo (IlvGraphic *graphic) |
Connects the animator with a given graphic object. | |
virtual void | animate () |
Called to animate the animator. | |
IlvGraphic * | getGraphic () const |
Returns the graphic object connected with the animator. | |
virtual void | initReDraws () const |
Called to begin a redraw session. | |
virtual void | invalidateRegion () const |
Called to invalidate the area affected by the animator. | |
virtual void | reDrawViews () const |
Called to finish a redraw session. | |
void | removeFrom (IlvGraphic *graphic) |
Disconnects the animator from the given graphic object. | |
virtual void | stateChanged (IlUInt newState, IlUInt oldState) |
Called by IlvAnimator::changeState each time the animator state changes. | |
void | useApply (IlBoolean value) |
Specifies to the animator whether to use "applyTo" functions. | |
IlBoolean | usesApply () const |
Returns a Boolean indicating whether the animator will use "applyToObject" functions. | |
Static Public Member Functions | |
static IlvGraphicAnimator * | Get (const IlvGraphic *graphic, const IlSymbol *name) |
Returns the animator connected with a graphic object given its name. | |
static IlvGraphicAnimator * | RemoveFrom (IlvGraphic *graphic, const IlSymbol *name) |
Removes the menu item group from the specified abstract menu. |
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 = ((IlBoolean) 1) | |||
) |
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. param 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 void IlvGraphicAnimator::animate | ( | ) | [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 IlvGraphicAnimator* IlvGraphicAnimator::Get | ( | const IlvGraphic * | graphic, | |
const IlSymbol * | name | |||
) | [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 void IlvGraphicAnimator::initReDraws | ( | ) | const [virtual] |
Called to begin a redraw session.
You must redefine this method in a subclass.
reDraw
, invalidateRegion
, reDrawViews
Implements IlvAnimator.
virtual void IlvGraphicAnimator::invalidateRegion | ( | ) | const [virtual] |
Called to invalidate the area affected by the animator.
You must redefine this method in a subclass.
reDraw
, initReDraws
, reDrawViews
Implements IlvAnimator.
virtual void IlvGraphicAnimator::reDrawViews | ( | ) | const [virtual] |
Called to finish a redraw session.
You must redefine this method in a subclass.
reDraw
, initReDraws
, invalidateRegion
Implements IlvAnimator.
static IlvGraphicAnimator* IlvGraphicAnimator::RemoveFrom | ( | IlvGraphic * | graphic, | |
const IlSymbol * | name | |||
) | [static] |
void IlvGraphicAnimator::removeFrom | ( | IlvGraphic * | graphic | ) |
Disconnects the animator from the given graphic object.
graphic | The graphic object. |
GetAnimator
, addTo
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.
IlvGraphicHolder::applyToObject
, useApply
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.
IlvGraphicHolder::applyToObject
, useApply
© Copyright 2012, 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.