Main Page Class Hierarchy Compound List File List Compound Members

iRenderView Struct Reference

This interface represents all information needed to render some object in a current draw context. More...

#include <rview.h>

Inheritance diagram for iRenderView:

Public Methods
virtual csRenderContext*	GetRenderContext ()=0
	Get the current render context.
virtual void	CreateRenderContext ()=0
	Create a new render context. More...
virtual void	RestoreRenderContext (csRenderContext *original)=0
	Restore a render context. More...
virtual iCamera*	CreateNewCamera ()=0
	Create a new camera in the current render context. More...
virtual iEngine*	GetEngine ()=0
	Get the engine.
virtual iGraphics2D*	GetGraphics2D ()=0
	Get the 2D graphics subsystem.
virtual iGraphics3D*	GetGraphics3D ()=0
	Get the 3D graphics subsystem.
virtual void	SetFrustum (float lx, float rx, float ty, float by)=0
	Set the view frustum at z=1.
virtual void	GetFrustum (float &lx, float &rx, float &ty, float &by)=0
	Get the frustum.
virtual csRenderContextFrustum*	GetTopFrustum ()=0
	Get the top level frustum (corresponding with SetFrustum()).
virtual iClipper2D*	GetClipper ()=0
	Get the 2D clipper for this view.
virtual void	SetClipper (iClipper2D *clip)=0
	Set the 2D clipper for this view.
virtual bool	IsClipperRequired ()=0
	If true then we have to clip all objects to the portal frustum (returned with GetClipper()). More...
virtual bool	GetClipPlane (csPlane3 &pl)=0
	Get the 3D clip plane that should be used to clip all geometry. More...
virtual csPlane3&	GetClipPlane ()=0
	Get the clip plane.
virtual void	SetClipPlane (const csPlane3 &pl)=0
	Set the 3D clip plane that should be used to clip all geometry.
virtual void	UseClipPlane (bool u)=0
	Enable the use of a clip plane.
virtual void	UseClipFrustum (bool u)=0
	Enable the use of a clip frustum.
virtual csFogInfo*	GetFirstFogInfo ()=0
	Every fogged sector we encountered results in an extra structure in the following list. More...
virtual void	SetFirstFogInfo (csFogInfo *fi)=0
	Set the first fog info.
virtual bool	AddedFogInfo ()=0
	Return true if fog info has been added.
virtual void	ResetFogInfo ()=0
	Reset fog info.
virtual iCamera*	GetCamera ()=0
	Get the current camera.
virtual void	CalculateFogPolygon (G3DPolygonDP &poly)=0
	Calculate the fog information in the given G3DPolygonDP structure.
virtual void	CalculateFogPolygon (G3DPolygonDPFX &poly)=0
	Calculate the fog information in the given G3DPolygonDPFX structure.
virtual void	CalculateFogMesh (const csTransform &tr_o2c, G3DTriangleMesh &mesh)=0
	Calculate the fog information in the given G3DTriangleMesh structure. More...
virtual void	CalculateFogMesh (const csTransform &tr_o2c, G3DPolygonMesh &mesh)=0
	Calculate the fog information in the given G3DPolygonMesh structure. More...
virtual bool	TestBSphere (const csReversibleTransform &o2c, const csSphere &sphere)=0
	Test if the given bounding sphere (in object space coordinates) is visibile in this render view. More...
virtual bool	ClipBSphere (const csReversibleTransform &o2c, const csSphere &sphere, int &clip_portal, int &clip_plane, int &clip_z_plane)=0
	Check if the given bounding sphere (in object space coordinates) is visibile in this render view. More...
virtual bool	ClipBBox (const csBox2 &sbox, const csBox3 &cbox, int &clip_portal, int &clip_plane, int &clip_z_plane)=0
	Check if the screen bounding box of an object is visible in this render view. More...
virtual iSector*	GetThisSector ()=0
	Get current sector.
virtual void	SetThisSector (iSector *s)=0
	Set the current sector.
virtual iSector*	GetPreviousSector ()=0
	Get previous sector.
virtual void	SetPreviousSector (iSector *s)=0
	Set the previous sector.
virtual iPolygon3D*	GetPortalPolygon ()=0
	Get the portal polygon.
virtual void	SetPortalPolygon (iPolygon3D *poly)=0
	Set the portal polygon.
virtual int	GetRenderRecursionLevel ()=0
	Get render recursion level.
virtual void	SetRenderRecursionLevel (int rec)=0
	Set render recursion level.
virtual void	AttachRenderContextData (void key, iBase data)=0
	Attach data to the current render context.
virtual iBase*	FindRenderContextData (void *key)=0
	Look for data on the current render context.
virtual void	DeleteRenderContextData (void *key)=0
	Delete all data with the given key on the current render context.
virtual void	SetCallback (iDrawFuncCallback *cb)=0
	Set a callback that will be called instead of drawing something. More...
virtual iDrawFuncCallback*	GetCallback ()=0
	Get the callback.
virtual void	CallCallback (int type, void *data)=0
	Call callback.
virtual iCamera*	GetOriginalCamera () const=0
	Get the original camera for this render view. More...

Detailed Description

This interface represents all information needed to render some object in a current draw context.

Member Function Documentation

void iRenderView::CalculateFogMesh ( const csTransform & tr_o2c,

G3DPolygonMesh & mesh ) [pure virtual]

Calculate the fog information in the given G3DPolygonMesh structure.
This function assumes the fog array is already preallocated and the rest of the structure should be filled in. This function will take care of correctly enabling/disabling fog.
Reimplemented in csRenderView.

void iRenderView::CalculateFogMesh ( const csTransform & tr_o2c,

G3DTriangleMesh & mesh ) [pure virtual]

Calculate the fog information in the given G3DTriangleMesh structure.
This function assumes the fog array is already preallocated and the rest of the structure should be filled in. This function will take care of correctly enabling/disabling fog.
Reimplemented in csRenderView.

bool iRenderView::ClipBBox ( const csBox2 & sbox,

const csBox3 & cbox,

int & clip_portal,

int & clip_plane,

int & clip_z_plane ) [pure virtual]

Check if the screen bounding box of an object is visible in this render view.
If true is returned (visible) then clip_plane, clip_z_plane, and clip_portal will be set to the right value depending on wether or not clipping is wanted. This function also does far plane clipping.
Reimplemented in csRenderView.

bool iRenderView::ClipBSphere ( const csReversibleTransform & o2c,

const csSphere & sphere,

int & clip_portal,

int & clip_plane,

int & clip_z_plane ) [pure virtual]

Check if the given bounding sphere (in object space coordinates) is visibile in this render view.
The given transformation should transform object to camera space. If the sphere is visible this function will also initialize the clip_plane, clip_z_plane, and clip_portal fields which can be used for DrawTriangleMesh or DrawPolygonMesh.
Reimplemented in csRenderView.

iCamera * iRenderView::CreateNewCamera ( ) [pure virtual]

Create a new camera in the current render context.
This function will create a new camera based on the current one. The new camera reference is returned.
Reimplemented in csRenderView.

void iRenderView::CreateRenderContext ( ) [pure virtual]

Create a new render context.
This is typically used when going through a portal. Note that you should remember the old render context if you want to restore it later. The render context will get all the values from the current context (with SCF references properly incremented).
Reimplemented in csRenderView.

bool iRenderView::GetClipPlane ( csPlane3 & pl ) [pure virtual]

Get the 3D clip plane that should be used to clip all geometry.
If this function returns false then this plane is invalid and should not be used. Otherwise it must be used to clip the object before drawing.
Reimplemented in csRenderView.

csFogInfo * iRenderView::GetFirstFogInfo ( ) [pure virtual]

Every fogged sector we encountered results in an extra structure in the following list.
This is only used if we are doing vertex based fog. This function will return the first csFogInfo instance.
Reimplemented in csRenderView.

iCamera * iRenderView::GetOriginalCamera ( ) const [pure virtual]

Get the original camera for this render view.
This is the camera before any space warping portals.
Reimplemented in csRenderView.

bool iRenderView::IsClipperRequired ( ) [pure virtual]

If true then we have to clip all objects to the portal frustum (returned with GetClipper()).
Normally this is not needed but some portals require this. If GetClipPlane() returns true then the value of this function is also implied to be true.
Reimplemented in csRenderView.

void iRenderView::RestoreRenderContext ( csRenderContext * original ) [pure virtual]

Restore a render context.
Use this to restore a previously overwritten render context. This function will take care of properly cleaning up the current render context.
Reimplemented in csRenderView.

void iRenderView::SetCallback ( iDrawFuncCallback * cb ) [pure virtual]

Set a callback that will be called instead of drawing something.
This will be used by iEngine::DrawFunc().
Reimplemented in csRenderView.

bool iRenderView::TestBSphere ( const csReversibleTransform & o2c,

const csSphere & sphere ) [pure virtual]

Test if the given bounding sphere (in object space coordinates) is visibile in this render view.
The optional will transform object to camera space.
Reimplemented in csRenderView.

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

iengine/rview.h

iRenderView Struct Reference

Public Methods

Detailed Description

Member Function Documentation