IlvBitmapAnimator Class Reference

Named property class. More...

#include <ilviews/util/animator.h>

Inheritance diagram for IlvBitmapAnimator:

List of all members.

Public Member Functions
	IlvBitmapAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100)
	Constructor.
virtual IlvBitmap *	getBitmap () const =0
	Returns the bitmap animated by the animator.
virtual IlUInt	getStatesCount () const
	Returns the number of states of the animator.
virtual IlBoolean	isLastState (IlUInt state) const
	Returns a Boolean value indicating whether the specified state is the last one.
virtual void	stateChanged (IlUInt newState, IlUInt oldState)
	Called by IlvAnimator::changeState each time the animator state changes.

---

Detailed Description

Named property class.

Library: views

The IlvBitmapAnimator is an abstract class that deals with bitmap animation. The bitmap should support animation.

See also:

IlvGraphicAnimator

---

Constructor & Destructor Documentation

IlvBitmapAnimator::IlvBitmapAnimator	(	IlSymbol *	name,
		IlvAnimationMode	mode = IlvAnimationForward,
		IlUInt	period = 100
	)

Constructor.

Initializes a new instance of the IlvBitmapAnimator 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.

---

Member Function Documentation

virtual IlvBitmap* IlvBitmapAnimator::getBitmap

(

)

const [pure virtual]

Returns the bitmap animated by the animator.

Returns:

The bitmap animated by the animator.

virtual IlUInt IlvBitmapAnimator::getStatesCount

(

)

const [virtual]

Returns the number of states of the animator.

You must redefine this method in a subclass.

Returns:

The number of states of the animator.

See also:

nextState, changeState

Implements IlvAnimator.

virtual IlBoolean IlvBitmapAnimator::isLastState

(

IlUInt

state

)

const [virtual]

Returns a Boolean value indicating whether the specified state is the last one.

The default implementation compares state to the result of IlvAnimator::getStatesCount(). You can override this function in your own subclass if you do not know the total number of states that the animator has.

Parameters:

state

The state.

Returns:

A Boolean value indicating whether the state is the last state.

See also:

getStatesCount, nextState, changeState

Reimplemented from IlvAnimator.

virtual void IlvBitmapAnimator::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.