iVlkSelection Struct Reference

Inheritance diagram for iVlkSelection:

Detailed Description

Vlk selection interface.

Remarks

The vlk selection is a regular vlk entity and so can be used as such, query the iVlkEntity interface on the object.

Selection operations
virtual ni::tBool	ClearSelection ()=0
	Clear the selection. More...
virtual ni::tU32	GetNumSelections () const =0
	Get the number of selections. {Property}. More...
virtual vlk::iVlkEntity *	GetSelection (ni::tU32 anIndex) const =0
	Get the selection at the specified index. {Property}. More...
virtual ni::tBool	IsSelected (vlk::iVlkEntity *apEntity) const =0
	Check whether the specified entity is selected. More...
virtual ni::tBool	AddSelection (vlk::iVlkEntity *apEntity)=0
	Add selection. More...
virtual ni::tBool	RemoveSelection (vlk::iVlkEntity *apEntity)=0
	Remove a selection. More...

Selection messages
virtual ni::tBool	SendSelectionMessage (ni::tU32 aMsg, const ni::Var &avarA=niVarNull, const ni::Var &avarB=niVarNull, ni::tBool abBroadcast=ni::eFalse)=0
	Send a message to the selected entities. More...

Transform
virtual ni::tBool	SetTransformPositionFromSelectionAverage (ni::tBool abSet)=0
	Set whether the transform is set from the average position of all selected entities. More...
virtual ni::tBool	GetTransformPositionFromSelectionAverage () const =0
	Get whether the transform from the average position of all selected entities. More...
virtual ni::tBool	SetTransformParentOfSelection (ni::tBool abParent)=0
	Set wheter the selection transform is the parent of all selected entities. {Property}. More...
virtual ni::tBool	GetTransformParentOfSelection () const =0
	Get wheter the selection transform is the parent of all selected entities. {Property}. More...
virtual ni::tBool	UpdateTransformPosition ()=0
	Update the selection transform's position. More...

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual ni::tBool ClearSelection ( )

pure virtual

Clear the selection.

virtual ni::tU32 GetNumSelections ( ) const

pure virtual

Get the number of selections. {Property}.

virtual vlk::iVlkEntity* GetSelection ( ni::tU32  anIndex ) const

pure virtual

Get the selection at the specified index. {Property}.

virtual ni::tBool IsSelected ( vlk::iVlkEntity *  apEntity ) const

pure virtual

Check whether the specified entity is selected.

virtual ni::tBool AddSelection ( vlk::iVlkEntity *  apEntity )

pure virtual

Add selection.

virtual ni::tBool RemoveSelection ( vlk::iVlkEntity *  apEntity )

pure virtual

Remove a selection.

virtual ni::tBool SendSelectionMessage ( ni::tU32  aMsg, const ni::Var &  avarA = niVarNull, const ni::Var &  avarB = niVarNull, ni::tBool  abBroadcast = ni::eFalse  )

pure virtual

Send a message to the selected entities.

Remarks

If broadcast is true will send the message to this entity and all it's children aswell.

virtual ni::tBool SetTransformPositionFromSelectionAverage ( ni::tBool  abSet )

pure virtual

Set whether the transform is set from the average position of all selected entities.

Remarks

If not entities are selected the transform wont be moved.

The selection is moved when an entity is added or removed from the selection and when this method is called with true. {Property}

virtual ni::tBool GetTransformPositionFromSelectionAverage ( ) const

pure virtual

Get whether the transform from the average position of all selected entities.

Remarks

If not entities are selected the transform wont be moved. {Property}

virtual ni::tBool SetTransformParentOfSelection ( ni::tBool  abParent )

pure virtual

Set wheter the selection transform is the parent of all selected entities. {Property}.

virtual ni::tBool GetTransformParentOfSelection ( ) const

pure virtual

Get wheter the selection transform is the parent of all selected entities. {Property}.

virtual ni::tBool UpdateTransformPosition ( )

pure virtual

Update the selection transform's position.