iVlkLayer Struct Reference

Inheritance diagram for iVlkLayer:

Detailed Description

Vlk layer interface.

General
virtual iVlkEntity *	GetEntity () const =0
	Get the layer's entity. {Property}. More...
virtual void	SetLayerFlags (tVlkLayerFlags aType)=0
	Set the flags of the layer. {Property}. More...
virtual tVlkLayerFlags	GetLayerFlags () const =0
	Get the flags of the layer. {Property}. More...

Collisions and Dynamics
virtual ni::iCollideScene *	GetLayerCollideScene () const =0
	Get the collide scene. {Property}. More...
virtual ni::iDynamicsScene *	GetLayerDynamicsScene () const =0
	Get the dynamics scene. {Property}. More...
virtual ni::iCollideQuery *	GetLayerCollideQuery () const =0
	Get the layer's collide query. {Property}. More...
virtual ni::iCollideResponseTable *	GetLayerCollideResponseTable () const =0
	Get the layer's collide response table. {Property}. More...
virtual ni::tBool	SetCollideClass (ni::iHString *ahspA, ni::eCollideResponseType aRespType)=0
	Set/remove the default response sink from the specified response table. More...
virtual ni::tBool	SetCollideClassPair (ni::iHString *ahspA, ni::iHString *ahspB, ni::eCollideResponseType aRespType)=0
	Set/remove the default response sink from the specified response table. More...

Rendering
virtual ni::iVizCell *	GetLayerVizCell () const =0
	Get the viz cell of the layer. {Property}. More...
virtual ni::iPainterDrawSet *	GetLayerPainterDrawSet () const =0
	Get the painter draw set of the layer. {Property}. More...
virtual ni::iPainterStates *	GetLayerPainterStates () const =0
	Get the painter states of the layer. {Property}. More...
virtual ni::iPainterRenderContext *	GetLayerPainterRenderContext () const =0
	Get the painter render context of the layer. {Property}. More...
virtual ni::iCanvas *	GetLayerCanvas () const =0
	Get the canvas of the layer. {Property}. More...
virtual void	SetLayerCamera (iVlkCamera *apCamera)=0
	Set the active camera of the layer. {Property}. More...
virtual iVlkCamera *	GetLayerCamera () const =0
	Get the active camera of the layer. {Property}. More...
virtual void	SetViewport (const ni::sRectf &aVP)=0
	Set the layer's viewport. {Property}. More...
virtual ni::sRectf	GetViewport () const =0
	Get the layer's viewport. {Property}. More...
virtual ni::sRectf	ComputeViewport (const ni::sRectf &aRootRect, iVlkCamera *apCamera) const =0
	Compute the layer's rendering viewport. 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 iVlkEntity* GetEntity ( ) const

pure virtual

Get the layer's entity. {Property}.

virtual void SetLayerFlags ( tVlkLayerFlags  aType )

pure virtual

Set the flags of the layer. {Property}.

virtual tVlkLayerFlags GetLayerFlags ( ) const

pure virtual

Get the flags of the layer. {Property}.

virtual ni::iCollideScene* GetLayerCollideScene ( ) const

pure virtual

Get the collide scene. {Property}.

virtual ni::iDynamicsScene* GetLayerDynamicsScene ( ) const

pure virtual

Get the dynamics scene. {Property}.

virtual ni::iCollideQuery* GetLayerCollideQuery ( ) const

pure virtual

Get the layer's collide query. {Property}.

virtual ni::iCollideResponseTable* GetLayerCollideResponseTable ( ) const

pure virtual

Get the layer's collide response table. {Property}.

virtual ni::tBool SetCollideClass ( ni::iHString *  ahspA, ni::eCollideResponseType  aRespType  )

pure virtual

Set/remove the default response sink from the specified response table.

virtual ni::tBool SetCollideClassPair ( ni::iHString *  ahspA, ni::iHString *  ahspB, ni::eCollideResponseType  aRespType  )

pure virtual

Set/remove the default response sink from the specified response table.

virtual ni::iVizCell* GetLayerVizCell ( ) const

pure virtual

Get the viz cell of the layer. {Property}.

virtual ni::iPainterDrawSet* GetLayerPainterDrawSet ( ) const

pure virtual

Get the painter draw set of the layer. {Property}.

virtual ni::iPainterStates* GetLayerPainterStates ( ) const

pure virtual

Get the painter states of the layer. {Property}.

virtual ni::iPainterRenderContext* GetLayerPainterRenderContext ( ) const

pure virtual

Get the painter render context of the layer. {Property}.

virtual ni::iCanvas* GetLayerCanvas ( ) const

pure virtual

Get the canvas of the layer. {Property}.

Remarks

This is set when eVlkLayerFlags_RenderTarget is set.

virtual void SetLayerCamera ( iVlkCamera *  apCamera )

pure virtual

Set the active camera of the layer. {Property}.

Remarks

Updated by the timeline.

virtual iVlkCamera* GetLayerCamera ( ) const

pure virtual

Get the active camera of the layer. {Property}.

virtual void SetViewport ( const ni::sRectf &  aVP )

pure virtual

Set the layer's viewport. {Property}.

Remarks

The layer's viewport can be relative if pos or size are <= 1.0 or absolute in virtual pixels (which are set to the resolution of the graphic card by default).

virtual ni::sRectf GetViewport ( ) const

pure virtual

Get the layer's viewport. {Property}.

virtual ni::sRectf ComputeViewport ( const ni::sRectf &  aRootRect, iVlkCamera *  apCamera  ) const

pure virtual

Compute the layer's rendering viewport.

Parameters

aRootRect
apCamera	is the camera to use for computation. If NULL the layer's camera is used.

Remarks

Get the viewport in virtual pixels.