Inheritance diagram for iFixedStates:

Detailed Description

Graphics fixed pipeline states interface. {Serialize}.

Public Member Functions
virtual tPtr	GetDescStructPtr () const =0
	Get the states description structure pointer. {Property}. More...

virtual ni::tBool	SerializeDataTable (ni::iDataTable *apDT, tSerializeFlags aFlags)=0
	Serialize the states. 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...

General
virtual tBool	Copy (const iFixedStates *apStates)=0
	Copy another fixed pipeline states. More...

virtual iFixedStates *	Clone () const =0
	Clone this fixed pipeline states. More...

Matrices
virtual void	SetCameraViewMatrix (const sMatrixf &aVal)=0
	Set the fixed pipeline camera view matrix. (default identity) {Property}{Serialize}. More...

virtual void	SetOnlyCameraViewMatrix (const sMatrixf &aVal)=0
	Set only the fixed pipeline camera view matrix. (default identity) {Property}. More...

virtual sMatrixf	GetCameraViewMatrix () const =0
	Get the fixed pipeline camera view matrix. {Property}{Serialize}. More...

virtual sMatrixf	GetCameraInvViewMatrix () const =0
	Get the inverse camera view matrix. {Property}. More...

virtual void	SetCameraProjectionMatrix (const sMatrixf &aVal)=0
	Set the fixed pipeline camera projection matrix. (default identity) {Property}{Serialize}. More...

virtual void	SetOnlyCameraProjectionMatrix (const sMatrixf &aVal)=0
	Set only the fixed pipeline camera projection matrix. (default identity) {Property}. More...

virtual sMatrixf	GetCameraProjectionMatrix () const =0
	Get the fixed pipeline camera projection matrix. {Property}{Serialize}. More...

virtual sMatrixf	GetCameraInvProjectionMatrix () const =0
	Get the inverse camera projection matrix. {Property}. More...

virtual sMatrixf	GetCameraViewProjectionMatrix () const =0
	Get the camera view projection matrix. {Property}. More...

virtual sMatrixf	GetCameraInvViewProjectionMatrix () const =0
	Get the camera inverse view projection matrix. {Property}. More...

virtual void	SetViewMatrix (const sMatrixf &aVal)=0
	Set the fixed pipeline view matrix. (default identity) {Property}{Serialize}. More...

virtual sMatrixf	GetViewMatrix () const =0
	Get the fixed pipeline view matrix. {Property}{Serialize}. More...

virtual void	SetProjectionMatrix (const sMatrixf &aVal)=0
	Set the fixed pipeline projection matrix. (default identity) {Property}{Serialize}. More...

virtual sMatrixf	GetProjectionMatrix () const =0
	Get the fixed pipeline projection matrix. {Property}{Serialize}. More...

virtual sMatrixf	GetInvViewMatrix () const =0
	Get the inverse view matrix. {Property}. More...

virtual sMatrixf	GetViewProjectionMatrix () const =0
	Get the view projection matrix. {Property}. More...

virtual sMatrixf	GetInvViewProjectionMatrix () const =0
	Get the inverse view projection matrix. {Property}. More...

virtual sMatrixf	GetInvProjectionMatrix () const =0
	Get the inverse projection matrix. {Property}. More...

virtual void	SetLookAtMatrices (tBool abSetCameraMatrices, const sVec3f &avEye, const sVec3f &avAt, const sVec3f &avUp, tF32 afFovY, tF32 afAspect, tF32 afNear, tF32 afFar)=0
	Set a look at matrix and perspective projection in the view and projection matrices. More...

virtual void	SetOrthoMatrices (tBool abSetCameraMatrices, const sRectf &arectViewport, tF32 afNear, tF32 afFar)=0
	Set an orthographic projection in the view and projection matrices. More...

Member Function Documentation

virtual tBool Copy ( const iFixedStates * apStates )

pure virtual

Copy another fixed pipeline states.

virtual iFixedStates* Clone ( ) const

pure virtual

Clone this fixed pipeline states.

virtual void SetCameraViewMatrix ( const sMatrixf & aVal )

pure virtual

Set the fixed pipeline camera view matrix. (default identity) {Property}{Serialize}.

Remarks: This function will set the view matrix aswell

virtual void SetOnlyCameraViewMatrix ( const sMatrixf & aVal )

pure virtual

Set only the fixed pipeline camera view matrix. (default identity) {Property}.

Remarks: This function wont modify the view matrix

virtual sMatrixf GetCameraViewMatrix ( ) const

pure virtual

Get the fixed pipeline camera view matrix. {Property}{Serialize}.

virtual sMatrixf GetCameraInvViewMatrix ( ) const

pure virtual

Get the inverse camera view matrix. {Property}.

virtual void SetCameraProjectionMatrix ( const sMatrixf & aVal )

pure virtual

Set the fixed pipeline camera projection matrix. (default identity) {Property}{Serialize}.

Remarks: This function will set the projection matrix aswell

virtual void SetOnlyCameraProjectionMatrix ( const sMatrixf & aVal )

pure virtual

Set only the fixed pipeline camera projection matrix. (default identity) {Property}.

Remarks: This function wont modify the projection matrix

virtual sMatrixf GetCameraProjectionMatrix ( ) const

pure virtual

Get the fixed pipeline camera projection matrix. {Property}{Serialize}.

virtual sMatrixf GetCameraInvProjectionMatrix ( ) const

pure virtual

Get the inverse camera projection matrix. {Property}.

virtual sMatrixf GetCameraViewProjectionMatrix ( ) const

pure virtual

Get the camera view projection matrix. {Property}.

virtual sMatrixf GetCameraInvViewProjectionMatrix ( ) const

pure virtual

Get the camera inverse view projection matrix. {Property}.

virtual void SetViewMatrix ( const sMatrixf & aVal )

pure virtual

Set the fixed pipeline view matrix. (default identity) {Property}{Serialize}.

virtual sMatrixf GetViewMatrix ( ) const

pure virtual

Get the fixed pipeline view matrix. {Property}{Serialize}.

virtual void SetProjectionMatrix ( const sMatrixf & aVal )

pure virtual

Set the fixed pipeline projection matrix. (default identity) {Property}{Serialize}.

virtual sMatrixf GetProjectionMatrix ( ) const

pure virtual

Get the fixed pipeline projection matrix. {Property}{Serialize}.

virtual sMatrixf GetInvViewMatrix ( ) const

pure virtual

Get the inverse view matrix. {Property}.

virtual sMatrixf GetViewProjectionMatrix ( ) const

pure virtual

Get the view projection matrix. {Property}.

virtual sMatrixf GetInvViewProjectionMatrix ( ) const

pure virtual

Get the inverse view projection matrix. {Property}.

virtual sMatrixf GetInvProjectionMatrix ( ) const

pure virtual

Get the inverse projection matrix. {Property}.

virtual void SetLookAtMatrices	(	tBool	abSetCameraMatrices,
		const sVec3f &	avEye,
		const sVec3f &	avAt,
		const sVec3f &	avUp,
		tF32	afFovY,
		tF32	afAspect,
		tF32	afNear,
		tF32	afFar
	)

pure virtual

Set a look at matrix and perspective projection in the view and projection matrices.

Parameters

abSetCameraMatrices	if true the camera and render matrices will be set, if false only the render matrices will be set.
avEye	is the position of the camera
avAt	is the target of the camera
avUp	is the up direction of the camera
afFovY	is the vertical field of view of the camera, in radians
afAspect	is the aspect ratio of the projection (width/height)
afNear	is the distance of the near clip plane
afFar	is the distance of the far clip plane

virtual void SetOrthoMatrices	(	tBool	abSetCameraMatrices,
		const sRectf &	arectViewport,
		tF32	afNear,
		tF32	afFar
	)

pure virtual

Set an orthographic projection in the view and projection matrices.

Parameters

abSetCameraMatrices	if true the camera and render matrices will be set, if false only the render matrices will be set.
arectViewport	defines the orthographic projection area.
afNear	is the distance of the near clip plane
afFar	is the distance of the far clip plane

Remarks: Takes in account ni::eGraphicsCaps_OrthoProjectionOffset; This is meant to be used to do ortho projections at the screen's resolution. To do generic ortho projection generate your ortho projection matrix using MatrixOrthoOffCenterLH (for example) and set the view matrix to identity.

virtual tPtr GetDescStructPtr ( ) const

pure virtual

Get the states description structure pointer. {Property}.

virtual ni::tBool SerializeDataTable	(	ni::iDataTable *	apDT,
		tSerializeFlags	aFlags
	)

pure virtual

Serialize the states.

Detailed Description

Public Member Functions

General

Matrices

Member Function Documentation