rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvInvertAccessor Class Reference

Animation accessor used to make objects blink by alternating two of their attributes. More...

#include <ilviews/protos/animacc.h>

Inheritance diagram for IlvInvertAccessor:
IlvAnimationAccessor IlvUserAccessor IlvAccessor

List of all members.

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.

Protected Member Functions

virtual void doit ()
 Performs periodic updates of the accessor.

Detailed Description

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.


Constructor & Destructor Documentation

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.

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).

Member Function Documentation

virtual void IlvInvertAccessor::doit (  )  [protected, virtual]

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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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