Legion::ControlInstance Class Reference

The control instance is an instance of a control. More...

Collaboration diagram for Legion::ControlInstance:

Public Member Functions
	ControlInstance (ControlHandle handle)
	Constructor-This is called by the control manager and not to be instantiated by the end user. More...
virtual	~ControlInstance ()
	Destructor-This is called by the control manager and not to be called by the end user. More...
	ControlInstance (const ControlInstance &orig)
	copy constructor More...
ControlInstance &	operator= (const ControlInstance &orig)
	assignment operator More...
ControlHandle	handle () const
	Get the handle of this instance. Typically not called by the user. More...
ControlId	typeId () const
	Get unique type id of this class of controls. More...
void	setSourceId (ClientId id)
	get/set the sender of this control More...
ClientId	sourceId () const
void	setTargetId (ClientId id)
	get/st the receiver of this control. Could be broadcast More...
ClientId	targetId () const
template<typename DATA_TYPE >
DATA_TYPE	data (ParameterId parameterId) const
	Reads a data attribute from the control. More...
template<typename DATA_TYPE >
const Span< DATA_TYPE >	dataArray (ParameterId parameterId) const
	Reads an array attribute from the control. More...
template<typename DATA_TYPE >
void	setData (ParameterId parameterId, const DATA_TYPE &val)
	Sets a data attribute from the control. More...
template<typename DATA_TYPE >
void	setDataArray (ParameterId parameterId, const Span< DATA_TYPE > &val)
	Sets an array attribute for the control. More...
template<typename DATA_TYPE >
void	addDataArray (ParameterId parameterId, const Span< DATA_TYPE > &val)
	Adds to an array attribute for the control. More...
template<typename DATA_TYPE >
void	removeDataArray (ParameterId parameterId, const Span< DATA_TYPE > &val)
	Sets an array attribute for the control. More...
void	setDataArrayLength (ParameterId parameterId, UInt32 length)
	Sets a dynamic-length data array in the control. This makes a copy of the data. More...
UInt32	dataArrayLength (ParameterId parameterId) const

Protected Attributes
ControlHandle	myHandle

Detailed Description

The control instance is an instance of a control.

Controls are created through the control manager.

Constructor & Destructor Documentation

Legion::ControlInstance::ControlInstance

(

ControlHandle

handle

)

Constructor-This is called by the control manager and not to be instantiated by the end user.

virtual Legion::ControlInstance::~ControlInstance ( )

virtual

Destructor-This is called by the control manager and not to be called by the end user.

Legion::ControlInstance::ControlInstance

(

const ControlInstance &

orig

)

copy constructor

Member Function Documentation

template<typename DATA_TYPE >

void Legion::ControlInstance::addDataArray	(	ParameterId	parameterId,
		const Span< DATA_TYPE > &	val
	)

Adds to an array attribute for the control.

template<typename DATA_TYPE >

DATA_TYPE Legion::ControlInstance::data

(

ParameterId

parameterId

)

const

Reads a data attribute from the control.

template<typename DATA_TYPE >

const Span<DATA_TYPE> Legion::ControlInstance::dataArray

(

ParameterId

parameterId

)

const

Reads an array attribute from the control.

UInt32 Legion::ControlInstance::dataArrayLength

(

ParameterId

parameterId

)

const

ControlHandle Legion::ControlInstance::handle

(

)

const

Get the handle of this instance. Typically not called by the user.

ControlInstance& Legion::ControlInstance::operator=

(

const ControlInstance &

orig

)

assignment operator

template<typename DATA_TYPE >

void Legion::ControlInstance::removeDataArray	(	ParameterId	parameterId,
		const Span< DATA_TYPE > &	val
	)

Sets an array attribute for the control.

template<typename DATA_TYPE >

void Legion::ControlInstance::setData	(	ParameterId	parameterId,
		const DATA_TYPE &	val
	)

Sets a data attribute from the control.

template<typename DATA_TYPE >

void Legion::ControlInstance::setDataArray	(	ParameterId	parameterId,
		const Span< DATA_TYPE > &	val
	)

Sets an array attribute for the control.

void Legion::ControlInstance::setDataArrayLength	(	ParameterId	parameterId,
		UInt32	length
	)

Sets a dynamic-length data array in the control. This makes a copy of the data.

void Legion::ControlInstance::setSourceId

(

ClientId

id

)

get/set the sender of this control

void Legion::ControlInstance::setTargetId

(

ClientId

id

)

get/st the receiver of this control. Could be broadcast

ClientId Legion::ControlInstance::sourceId

(

)

const

ClientId Legion::ControlInstance::targetId

(

)

const

ControlId Legion::ControlInstance::typeId

(

)

const

Get unique type id of this class of controls.

Member Data Documentation

ControlHandle Legion::ControlInstance::myHandle

protected

---

The documentation for this class was generated from the following file:

• controlInstance.h