IlvGroupUserAccessor Class Reference

References all the subattributes of a group that have the same name. More...

#include <ilviews/protos/useracc.h>

Inheritance diagram for IlvGroupUserAccessor:

Public Member Functions
	IlvGroupUserAccessor (const char *name, IlvValueTypeClass *type)
	Initializes a new group accessor. More...
Public Member Functions inherited from IlvUserAccessor
	IlvUserAccessor (const char *name, const IlvValueTypeClass *type, IlUInt flags=0)
	Constructor. More...
virtual void	initialize (const IlvAccessorHolder *object)
	Attachment method to an IlvAccessorHolder. 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 IlBoolean	changeValue (IlvAccessorHolder *, const IlvValue &)
	Called by the method IlvAccessible::changeValue() for each IlvAccessor attached to the IlvAccessorHolder.
virtual IlUInt	compareValues (const IlvAccessorHolder *, const IlvAccessible *, IlvValue *, IlUShort, IlvValueArray &) const
	Compares the values in ref and object and returns the differing values. More...
virtual IlvValue &	queryValue (const IlvAccessorHolder *, IlvValue &) const
	Called by the method IlvAccessible::queryValue() for each IlvAccessor attached to the IlvAccessorHolder.
Protected Member Functions inherited from IlvUserAccessor
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...

Detailed Description

References all the subattributes of a group that have the same name.

Library: ilvproto

IlvGroupUserAccessor is used to change and/or query a value for all the nodes in a group. It defines a global value that is dispatched to all the nodes in the group. In a programming language, this accessor would be similar to a pointer to a collection of attributes of the same name.

See Also

IlvGroupAccessor.

Constructor & Destructor Documentation

IlvGroupUserAccessor::IlvGroupUserAccessor	(	const char *	name,
		IlvValueTypeClass *	type
	)

Initializes a new group accessor.

When the value specified by name is changed for a group, the same value change will be forwarded to all the nodes of the group. When the value is queried for a group, it will be queried from all the nodes of the group, and the last value will be returned.

Member Function Documentation

virtual IlUInt IlvGroupUserAccessor::compareValues ( const IlvAccessorHolder *  object, const IlvAccessible *  ref, IlvValue *  values, IlUShort  count, IlvValueArray &  diffs  ) const

protectedvirtual

Compares the values in ref and object and returns the differing values.

Compares the objects object and ref for the values specified by the values array of length count.

The default implementation simply calls the IlvAccessible::compareValues(const IlvAccessible*, IlvValue*, IlUShort, IlvValueArray&) const method, which will query the values for the two objects and compare them one by one. Subclasses may compare values more cleverly by grouping differences: for example, the IlvGroupAccessor subclass detects when all nodes of a group differ homogeneously and reports only one difference for the whole group.

Parameters

object	The object to compare.
ref	The reference to compare to.
values	The values to be compared.
count	The number of elements in the array values.
diffs	Where the differences are stored.

Returns

The number of differences found. This is therefore the size of the output array diffs.

See Also

IlvAccessible::compareValues().

IlvProtoInstance, IlvPrototype.

Reimplemented from IlvUserAccessor.