 |
Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
Animation accessor used to make objects blink by alternating two of their attributes. More...
#include <ilviews/protos/animacc.h>
Public Member Functions | |
| IlvInvertAccessor (const char *name, const IlvValueTypeClass *type, IlvDisplay *display, const char *periodVal, const char *initialValue, const char *alternateValue) | |
| Creates a new animation accessor that makes the object blink, by swapping the values of the initialValue and alternateValue parameters. More... | |
 Public Member Functions inherited from IlvAnimationAccessor | |
| IlvAnimationAccessor (const char *name, const IlvValueTypeClass *type, IlvDisplay *display, const char *periodVal) | |
| Creates a new animation accessor. More... | |
| void | initialize (const IlvAccessorHolder *object) |
Attachment method to an IlvAccessorHolder. More... | |
| Public Member Functions inherited from IlvUserAccessor | |
| IlvUserAccessor (const char *name, const IlvValueTypeClass *type, IlUInt flags=0) | |
| Constructor. More... | |
| virtual IlBoolean | isOutputValue (const IlSymbol *) const |
| Queries if the accessor is an output accessor. More... | |
| IlBoolean | isPrivate () const |
| Checks the private status. More... | |
| IlBoolean | isRuntime () const |
| Checks the RunTime status. More... | |
| void | setPrivate (IlBoolean val) |
| Sets the Private flag of this accessor. More... | |
| void | setRuntime (IlBoolean runTime) |
| Sets the RunTime flag of this accessor. More... | |
| Public Member Functions inherited from IlvAccessor | |
| IlvAccessor (const char *name, IlvValueTypeClass *type) | |
| Creates a new accessor of name name and type type. | |
| virtual IlBoolean | changeValues (IlvAccessorHolder *object, const IlvValue *values, IlUShort count) |
Called by the method IlvAccessible::changeValues() for each IlvAccessor attached to the IlvAccessorHolder. | |
| virtual void | getAccessors (const IlSymbol *const **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const |
| Returns the names and types of the values handled by this accessor. More... | |
| const IlSymbol * | getName () const |
| Returns the name of the accessor. More... | |
| IlvValueTypeClass * | getType () const |
| Returns the type of the accessor. More... | |
| virtual IlBoolean | isOutputAccessor (IlBoolean &inputAndOutput) |
| Queries if the accessor is an output accessor. More... | |
| virtual IlShort | matchValues (const IlvAccessorHolder *object, const IlvValue *values, IlUShort count, IlvValue *matchingValues=0) const |
| Returns the number of values that are handled by the accessor in the values array of length count. More... | |
| virtual void | queryValues (const IlvAccessorHolder *object, IlvValue *values, IlUShort count) const |
Called by the method IlvAccessible::queryValues() for each IlvAccessor attached to the IlvAccessorHolder. | |
| void | setName (const IlSymbol *name) |
| Sets the name of the accessor. More... | |
Protected Member Functions | |
| virtual void | doit () |
| Performs periodic updates of the accessor. More... | |
| Protected Member Functions inherited from IlvAnimationAccessor | |
| virtual IlBoolean | changeValue (IlvAccessorHolder *object, const IlvValue &val) |
Called by the method IlvAccessible::changeValue() for each IlvAccessor attached to the IlvAccessorHolder. | |
| IlvDisplay * | getDisplay () |
| Returns the display to which the accessor is associated. More... | |
| IlvAccessorHolder * | getObject () |
| The object to which the accessor belongs. More... | |
| IlUInt | getPeriod () |
| Returns the period of the associated timer. More... | |
| virtual IlvValue & | queryValue (const IlvAccessorHolder *object, IlvValue &val) const |
Called by the method IlvAccessible::queryValue() for each IlvAccessor attached to the IlvAccessorHolder. | |
| void | setTimer (IlUInt p) |
| Sets the timer period. More... | |
| Protected Member Functions inherited from IlvUserAccessor | |
| virtual IlUInt | compareValues (const IlvAccessorHolder *object, const IlvAccessible *ref, IlvValue *values, IlUShort count, IlvValueArray &diffs) const |
| Compares the values in ref and object and returns the differing values. More... | |
| IlBoolean | getValue (IlvValue &val, const IlvAccessorHolder *object, IlvDisplay *display, IlvValueTypeClass *typeClass=0, IlSymbol *typeVal=0, const IlvValue *arg=0) const |
| Evaluates a parameter of a user accessor. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from IlvAnimationAccessor | |
| static IlBoolean | GetTimersActive () |
| Indicates whether timers are active or not. More... | |
| static void | SetTimersActive (IlBoolean running) |
| Starts or stops all timers. More... | |
| static void | UseSharedTimers (IlBoolean shared) |
| Specifies whether animation accessors should be shared. More... | |
| static IlBoolean | UseSharedTimers () |
| Indicates whether timers are shared among animation accessors. More... | |
Animation accessor used to make objects blink by alternating two of their attributes.
Library: ilvproto
The values will most often be either foreground and background to make whole group flash, or <nodename>.foreground and <nodename>.background so that only a particular node flashes. The periodVal parameter can contain a constant value, the name of another accessor, or an arithmetic expression that can contain accessor names and/or constants (see IlvUserAccessor::getValue).
If the application uses shared timers (see IlvAnimationAccessor), all the invert accessors are synchronized, which means that all colors are inverted at the same time. Furthermore, when an invert accessor is stopped, the object is always left with its initial color.
| IlvInvertAccessor::IlvInvertAccessor | ( | const char * | name, |
| const IlvValueTypeClass * | type, | ||
| IlvDisplay * | display, | ||
| const char * | periodVal, | ||
| const char * | initialValue, | ||
| const char * | alternateValue | ||
| ) |
Creates a new animation accessor that makes the object blink, by swapping the values of the initialValue and alternateValue parameters.
| name | Accessor name. |
| type | Value type. |
| display | Used to initialize the timers. |
| initialValue | The initial attribute exchanged periodically with alternateValue. |
| alternateValue | The attribute periodically exchanged with initialValue. |
| periodVal | Specifies the interval (in milliseconds) at which initialValue and alternateValue attributes will be swapped (see IlvAnimationAccessor). This parameter can contain a constant value, the name of another accessor, or an arithmetic expression that can contain accessor names and/or constants (see IlvUserAccessor::getValue). |
|
protectedvirtual |
Performs periodic updates of the accessor.
This method is called repeatedly by the IlvAnimationAccessor object at the time interval specified by the periodVal argument of the constructor. It must be redefined by subclasses to perform a visual or audio animation effect. Its default behavior implements the clock behavior: it triggers regularly the attribute it is attached to.
Reimplemented from IlvAnimationAccessor.
© 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.