Inheritance diagram for iVizObject:

Detailed Description

Viz object.

Public Member Functions
virtual void	SetUserObject (iUnknown *apObject)=0
	Set the user object. {Property}. More...

virtual iUnknown *	GetUserObject () const =0
	Get the user object. {Property}. More...

virtual sVec3f	GetMin () const =0
	Get the object's AABB min value. {Property}. More...

virtual sVec3f	GetMax () const =0
	Get the object's AABB max value. {Property}. More...

virtual sVec4f	GetSphere () const =0
	Get the object's bounding sphere. {Property}. More...

virtual ni::tBool	SetVisibilityParent (iVizObject *apObject)=0
	Set the object's visibility parent. {Property}. More...

virtual iVizObject *	GetVisibilityParent () const =0
	Get the object's visibility parent. {Property}. More...

virtual ni::tBool	SetCell (iVizCell *apCell)=0
	Set the cell the object belongs to. {Property}. More...

virtual iVizCell *	GetCell () const =0
	Get the cell the object belongs to. {Property}. More...

virtual ni::tBool	SetTestShape (iVizShape *apShape)=0
	Set the object's test shape. {Property}. More...

virtual iVizShape *	GetTestShape () const =0
	Get the object's test shape. {Property}. More...

virtual ni::tBool	SetWriteShape (iVizShape *apShape)=0
	Set the object's write shape. {Property}. More...

virtual iVizShape *	GetWriteShape () const =0
	Get the object's write shape. {Property}. More...

virtual void	SetMatrix (const sMatrixf &aMatrix)=0
	Set the object's 'object-to-cell/world' matrix. {Property}. More...

virtual sMatrixf	GetMatrix () const =0
	Get the object's 'object-to-cell/world' matrix. {Property}. More...

virtual void	SetEnabled (ni::tBool abEnabled)=0
	Set whether the object is enabled. {Property}. More...

virtual ni::tBool	GetEnabled () const =0
	Get whether the object is enabled. {Property}. More...

virtual void	SetIsOccluder (ni::tBool abOccluder)=0
	Set whether the object is an occluder. {Property}. More...

virtual ni::tBool	GetIsOccluder () const =0
	Get whether the object is an occluder. {Property}. More...

virtual void	SetUnbounded (ni::tBool abUnbounded)=0
	Set whether the object is unbounded. More...

virtual ni::tBool	GetUnbounded () const =0
	Get whether the object is unbounded. {Property}. More...

virtual void	SetCost (const sVec3i &avCost)=0
	Set the object's rendering cost. {Property}. More...

virtual sVec3i	GetCost () const =0
	Get the object's rendering cost. {Property}. More...

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 void SetUserObject ( iUnknown * apObject )

pure virtual

Set the user object. {Property}.

Remarks: The object must implement the interface requested by iViz::SetUserObjectUUID.

virtual iUnknown* GetUserObject ( ) const

pure virtual

Get the user object. {Property}.

virtual sVec3f GetMin ( ) const

pure virtual

Get the object's AABB min value. {Property}.

virtual sVec3f GetMax ( ) const

pure virtual

Get the object's AABB max value. {Property}.

virtual sVec4f GetSphere ( ) const

pure virtual

Get the object's bounding sphere. {Property}.

virtual ni::tBool SetVisibilityParent ( iVizObject * apObject )

pure virtual

Set the object's visibility parent. {Property}.

virtual iVizObject* GetVisibilityParent ( ) const

pure virtual

Get the object's visibility parent. {Property}.

virtual ni::tBool SetCell ( iVizCell * apCell )

pure virtual

Set the cell the object belongs to. {Property}.

virtual iVizCell* GetCell ( ) const

pure virtual

Get the cell the object belongs to. {Property}.

virtual ni::tBool SetTestShape ( iVizShape * apShape )

pure virtual

Set the object's test shape. {Property}.

virtual iVizShape* GetTestShape ( ) const

pure virtual

Get the object's test shape. {Property}.

virtual ni::tBool SetWriteShape ( iVizShape * apShape )

pure virtual

Set the object's write shape. {Property}.

Remarks: Set the write shape to be used as occluders in the software occlusion mode. Write models are ignored in the hardware occlusion mode.; The write shape can be disabled by assigning a NULL write shape (this is the default). If no write shape is assigned, the object is never used as an occluder in software occlusion mode.

virtual iVizShape* GetWriteShape ( ) const

pure virtual

Get the object's write shape. {Property}.

virtual void SetMatrix ( const sMatrixf & aMatrix )

pure virtual

Set the object's 'object-to-cell/world' matrix. {Property}.

virtual sMatrixf GetMatrix ( ) const

pure virtual

Get the object's 'object-to-cell/world' matrix. {Property}.

virtual void SetEnabled ( ni::tBool abEnabled )

pure virtual

Set whether the object is enabled. {Property}.

Remarks: Default is true

virtual ni::tBool GetEnabled ( ) const

pure virtual

Get whether the object is enabled. {Property}.

virtual void SetIsOccluder ( ni::tBool abOccluder )

pure virtual

Set whether the object is an occluder. {Property}.

Remarks: Default is true

virtual ni::tBool GetIsOccluder ( ) const

pure virtual

Get whether the object is an occluder. {Property}.

virtual void SetUnbounded ( ni::tBool abUnbounded )

pure virtual

Set whether the object is unbounded.

Remarks: The object test shape is ignored, object regarded to be of infinite size and reported as always visible. {Property}

virtual ni::tBool GetUnbounded ( ) const

pure virtual

Get whether the object is unbounded. {Property}.

virtual void SetCost ( const sVec3i & avCost )

pure virtual

Set the object's rendering cost. {Property}.

Remarks: The cost is a vector3 which is defined as such : Vec3(numVertices,numTriangles,complexity). 'complexity' is a value between 0 and 10000 which defines the relative complexity of the object (shader complexity, skinned, ...).

virtual sVec3i GetCost ( ) const

pure virtual

Get the object's rendering cost. {Property}.

See also: SetCost

Detailed Description

Public Member Functions

Member Function Documentation