rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members | Public Member Functions
IlvBitmapAnimator Class Referenceabstract

Named property class. More...

#include <ilviews/util/animator.h>

Inheritance diagram for IlvBitmapAnimator:
IlvAnimator IlvNamedProperty

Public Member Functions

 IlvBitmapAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100)
 Constructor. More...
 
virtual IlvBitmapgetBitmap () const =0
 Returns the bitmap animated by the animator. More...
 
virtual IlUInt getStatesCount () const
 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 void stateChanged (IlUInt newState, IlUInt oldState)
 Called by IlvAnimator::changeState each time the animator state changes. More...
 
- Public Member Functions inherited from IlvAnimator
 IlvAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100)
 Constructor. More...
 
virtual void animate ()
 Called to animate the animator. 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 void initReDraws () const =0
 Called to begin a redraw session. More...
 
virtual void invalidateRegion () const =0
 Called to invalidate the area affected by the animator. 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...
 
virtual void reDrawViews () const =0
 Called to finish a redraw session. 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...
 
IlvNamedPropertycopy () const =0
 Copies the property. More...
 
const char * getName () const
 Gets the name of the property. More...
 
IlSymbolgetSymbol () 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...
 

Additional Inherited Members

- Public Types inherited from IlvAnimator
enum  IlvAnimationMode {
  IlvAnimationNone, IlvAnimationForward, IlvAnimationBackward, IlvAnimationForwardOnce,
  IlvAnimationBackwardOnce
}
 This enumeration defines the possible values for the animation mode of an IlvAnimator object. More...
 
- Public Attributes inherited from IlvNamedProperty
IlvNamedProperty *IlvInputFilestream
 Reads an instance of the property class. More...
 

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
nameThe animator name.
modeThe animation mode.
periodThe 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
stateThe 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
newStateThe new animator state.
oldStateThe previous animator state.
See Also
getState(), nextState(), changeState()

Reimplemented from IlvAnimator.


© Copyright 2015, 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.