IlvMinMaxAccessor Class Reference

Modifies an attribute with respect to numerical bounds. More...

#include <ilviews/protos/condacc.h>

Inheritance diagram for IlvMinMaxAccessor:

Public Member Functions
	IlvMinMaxAccessor (const char *name, const IlvValueTypeClass *type, IlvDisplay *display, const char *minimumValue, const char *maximumValue, const char *exceptValue, const char *assignedAttribute, const char *valueIfBelow, const char *valueIfInBetween, const char *valueIfAbove)
	Creates a new IlvMinMaxAccessor. 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 IlvValue &	queryValue (const IlvAccessorHolder *object, IlvValue &val) const
	Called by the method IlvAccessible::queryValue() for each IlvAccessor attached to the IlvAccessorHolder.
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 *object, const IlvValue &val)
	Called by the method IlvAccessible::changeValue() for each IlvAccessor attached to the IlvAccessorHolder.
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...

Detailed Description

Modifies an attribute with respect to numerical bounds.

Library: ilvproto
Specialized accessor that handles values with a minimum and a maximum boundary. This accessor allows you to modify another attribute when the value goes beyond the minimum and the maximum values specified.

Constructor & Destructor Documentation

IlvMinMaxAccessor()

IlvMinMaxAccessor::IlvMinMaxAccessor	(	const char *	name,
		const IlvValueTypeClass *	type,
		IlvDisplay *	display,
		const char *	minimumValue,
		const char *	maximumValue,
		const char *	exceptValue,
		const char *	assignedAttribute,
		const char *	valueIfBelow,
		const char *	valueIfInBetween,
		const char *	valueIfAbove
	)

Creates a new IlvMinMaxAccessor.

minimumValue, maximumValue, exceptValue, valueIfBelow, valueIfInBetween, and valueIfAbove 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()).

Parameters

name	Name of the accessor.
type	Type of the accessor. It will most likely be a numeric type, such as IlvValueIntType or IlvValueFloatType.
display	Display used to initialize value types.
minimumValue	Minimum bound used for the conditional assignment.
maximumValue	Maximum bound used for the conditional assignment.
exceptValue	Boolean value that is tested before performing the assignment. If it returns IlTrue, the conditional assignment is not performed.
assignedAttribute	Attribute changed when the test is evaluated.
valueIfBelow	Value assigned to assignedAttribute if the current value is below minimumValue.
valueIfInBetween	Value assigned to assignedAttribute if the current value is between maximumValue and minimumValue.
valueIfAbove	Value assigned to assignedAttribute if the current value is above maximumValue.