IlvGraphicAnimator Class Reference

Named property class. More...

#include <ilviews/util/animator.h>

Inheritance diagram for IlvGraphicAnimator:

List of all members.

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.

---

Detailed Description

Named property class.

Library: views

IlvGraphicAnimator is a subclass of IlvAnimator that deals with animation of IlvGraphic objects.

See also:

IlvBitmapAnimator

---

Constructor & Destructor Documentation

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.

Parameters:

	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.

---

Member Function Documentation

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.

Parameters:

graphic

The graphic object.

See also:

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.

See also:

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.

Parameters:

	graphic	The graphic object.
	name	The animator name.

Returns:

The animator named name connected with graphic.

See also:

addTo, removeFrom

IlvGraphic* IlvGraphicAnimator::getGraphic

(

)

const

Returns the graphic object connected with the animator.

Returns:

The graphic object connected with this animator.

virtual void IlvGraphicAnimator::initReDraws

(

)

const [virtual]

Called to begin a redraw session.

You must redefine this method in a subclass.

See also:

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.

See also:

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.

See also:

reDraw, initReDraws, invalidateRegion

Implements IlvAnimator.

static IlvGraphicAnimator* IlvGraphicAnimator::RemoveFrom	(	IlvGraphic *	graphic,
		const IlSymbol *	name
	)			[static]

Removes the menu item group from the specified abstract menu.

Parameters:

	menu	The abstract menu.
	name	The group name.

See also:

Get, addTo

void IlvGraphicAnimator::removeFrom

(

IlvGraphic *

graphic

)

Disconnects the animator from the given graphic object.

Parameters:

graphic

The graphic object.

See also:

GetAnimator, addTo

virtual void IlvGraphicAnimator::stateChanged	(	IlUInt	newState,
		IlUInt	oldState
	)			[virtual]

Called by IlvAnimator::changeState each time the animator state changes.

The default implementation does nothing.

Parameters:

	newState	The new animator state.
	oldState	The previous animator state.

See also:

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.

See also:

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.

Returns:

A Boolean indicating whether the animator will use "applyToObject" functions.

See also:

IlvGraphicHolder::applyToObject, useApply