IlvBlinkAccessor Class Reference

Makes objects blink by switching their visible value back and forth. More...

#include <ilviews/protos/animacc.h>

Inheritance diagram for IlvBlinkAccessor:

Public Member Functions
	IlvBlinkAccessor (const char *name, const IlvValueTypeClass *type, IlvDisplay *display, const char *periodVal, const char *booleanValue)
	Creates a new animation accessor that makes the object blink. 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)
	Creates a new user accessor of name name and type type. More...
virtual IlBoolean	isOutputValue (const IlSymbol *name) const
	Queries if the accessor is an output accessor. More...
IlBoolean	isPrivate () const
	Returns IlTrue if the accessor has the private flag set. Otherwise, it returns IlFalse.
IlBoolean	isRuntime () const
	Returns IlTrue if the accessor has the RunTime flag set. Otherwise, it returns IlFalse.
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...

Detailed Description

Makes objects blink by switching their visible value back and forth.

Library: ilvproto

This accessor works by switching a Boolean attribute back and forth between IlTrue and IlFalse. This attribute is often the "visible" attribute of a graphic node, which has the effect of making the object blink. If the application uses shared timers (see IlvAnimationAccessor), all the blink accessors are synchronized. This means that all the blinking objects become visible at the same time, and are hidden at the same time. When a blink accessor is stopped, the blinking object is always left in its initial state.

Constructor & Destructor Documentation

IlvBlinkAccessor::IlvBlinkAccessor	(	const char *	name,
		const IlvValueTypeClass *	type,
		IlvDisplay *	display,
		const char *	periodVal,
		const char *	booleanValue
	)

Creates a new animation accessor that makes the object blink.

Parameters

name	Name of the accessor.
type	Type of the value.
display	Needed to initialize the timers.
booleanValue	Attribute that is alternatively set and unset.
periodVal	Specifies the interval (in milliseconds) at which booleanValue will be changed (see IlvAnimationAccessor). periodVal 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 IlvBlinkAccessor::doit ( )

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.