 |
Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
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 | |
| IlvBitmapAnimator (IlSymbol *name, IlvAnimationMode mode=IlvAnimationForward, IlUInt period=100) | |
| Constructor. More... | |
| virtual IlvBitmap * | getBitmap () 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... | |
| 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... | |
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 *IlvInputFile & | stream |
| Reads an instance of the property class. More... | |
Named property class.
Library: views
The IlvBitmapAnimator is an abstract class that deals with bitmap animation. The bitmap should support animation.
IlvGraphicAnimator | 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.
| name | The animator name. |
| mode | The animation mode. |
| period | The animator period. |
|
pure virtual |
Returns the bitmap animated by the animator.
|
virtual |
Returns the number of states of the animator.
You must redefine this method in a subclass.
nextState(), changeState() Implements IlvAnimator.
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.
| state | The state. |
getStatesCount(), nextState(), changeState() Reimplemented from IlvAnimator.
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.
© Copyright 2017, 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.