CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iRenderView Struct Reference
[Views & Cameras]

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

#include <rview.h>

Inheritance diagram for iRenderView:

iBase List of all members.

Public Methods

virtual csRenderContextGetRenderContext ()=0
 Get the current render context.

virtual iEngineGetEngine ()=0
 Get the engine.

virtual iGraphics2DGetGraphics2D ()=0
 Get the 2D graphics subsystem.

virtual iGraphics3DGetGraphics3D ()=0
 Get the 3D graphics subsystem.

virtual void GetFrustum (float &lx, float &rx, float &ty, float &by)=0
 Get the frustum.

virtual iClipper2DGetClipper ()=0
 Get the 2D clipper for this view.

virtual iCameraGetCamera ()=0
 Get the current camera.

virtual void CalculateFogPolygon (G3DPolygonDP &poly)=0
 @@OR@@ Calculate the fog information in the given G3DPolygonDP structure.

virtual void CalculateFogPolygon (G3DPolygonDPFX &poly)=0
 @@OR@@ Calculate the fog information in the given G3DPolygonDPFX structure.

virtual void CalculateFogMesh (const csTransform &tr_o2c, G3DTriangleMesh &mesh)=0
 @@OR@@ Calculate the fog information in the given G3DTriangleMesh structure.

virtual void CalculateFogMesh (const csTransform &tr_o2c, G3DPolygonMesh &mesh)=0
 @@OR@@ Calculate the fog information in the given G3DPolygonMesh structure.

virtual void CalculateClipSettings (uint32 frustum_mask, int &clip_portal, int &clip_plane, int &clip_z_plane)=0
 Given a frustum_mask, calculate the clip settings.

virtual bool TestBSphere (const csReversibleTransform &w2c, const csSphere &sphere)=0
 Test if the given bounding sphere (in world space coordinates) is visible in this render view.

virtual bool ClipBBox (csPlane3 *planes, uint32 &frustum_mask, const csBox3 &obox, int &clip_portal, int &clip_plane, int &clip_z_plane)=0
 Check if the object space bounding box of an object is visible in this render view.

virtual void SetupClipPlanes (const csReversibleTransform &tr_o2c, csPlane3 *planes, uint32 &frustum_mask)=0
 Setup clipping planes in object space.

virtual iSectorGetThisSector ()=0
 Get current sector.

virtual iSectorGetPreviousSector ()=0
 Get previous sector.

virtual iPortalGetLastPortal ()=0
 Get the portal we last traversed through.

virtual iCameraGetOriginalCamera () const=0
 Get the original camera for this render view.

virtual uint GetCurrentFrameNumber () const=0
 Get the number of the current frame.


Detailed Description

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

Definition at line 174 of file rview.h.


Member Function Documentation

virtual void iRenderView::CalculateClipSettings uint32    frustum_mask,
int &    clip_portal,
int &    clip_plane,
int &    clip_z_plane
[pure virtual]
 

Given a frustum_mask, calculate the clip settings.

virtual void iRenderView::CalculateFogMesh const csTransform   tr_o2c,
G3DPolygonMesh   mesh
[pure virtual]
 

@@OR@@ 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.

virtual void iRenderView::CalculateFogMesh const csTransform   tr_o2c,
G3DTriangleMesh   mesh
[pure virtual]
 

@@OR@@ 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.

virtual void iRenderView::CalculateFogPolygon G3DPolygonDPFX   poly [pure virtual]
 

@@OR@@ Calculate the fog information in the given G3DPolygonDPFX structure.

virtual void iRenderView::CalculateFogPolygon G3DPolygonDP   poly [pure virtual]
 

@@OR@@ Calculate the fog information in the given G3DPolygonDP structure.

virtual bool iRenderView::ClipBBox csPlane3   planes,
uint32   frustum_mask,
const csBox3   obox,
int &    clip_portal,
int &    clip_plane,
int &    clip_z_plane
[pure virtual]
 

Check if the object space 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. Use SetupClipPlanes() to get the clipping planes for this function. The frustum_mask will be modified according to all clip planes that were relevant for the given box. That can be used to hierarchically cull smaller objects.

virtual iCamera* iRenderView::GetCamera   [pure virtual]
 

Get the current camera.

virtual iClipper2D* iRenderView::GetClipper   [pure virtual]
 

Get the 2D clipper for this view.

virtual uint iRenderView::GetCurrentFrameNumber   [pure virtual]
 

Get the number of the current frame.

virtual iEngine* iRenderView::GetEngine   [pure virtual]
 

Get the engine.

virtual void iRenderView::GetFrustum float &    lx,
float &    rx,
float &    ty,
float &    by
[pure virtual]
 

Get the frustum.

virtual iGraphics2D* iRenderView::GetGraphics2D   [pure virtual]
 

Get the 2D graphics subsystem.

virtual iGraphics3D* iRenderView::GetGraphics3D   [pure virtual]
 

Get the 3D graphics subsystem.

virtual iPortal* iRenderView::GetLastPortal   [pure virtual]
 

Get the portal we last traversed through.

virtual iCamera* iRenderView::GetOriginalCamera   [pure virtual]
 

Get the original camera for this render view.

This is the camera before any space warping portals.

virtual iSector* iRenderView::GetPreviousSector   [pure virtual]
 

Get previous sector.

virtual csRenderContext* iRenderView::GetRenderContext   [pure virtual]
 

Get the current render context.

virtual iSector* iRenderView::GetThisSector   [pure virtual]
 

Get current sector.

virtual void iRenderView::SetupClipPlanes const csReversibleTransform   tr_o2c,
csPlane3   planes,
uint32   frustum_mask
[pure virtual]
 

Setup clipping planes in object space.

The input arrays for planes should each be able to hold 10 planes. Returns a mask that you can use for the csIntersect3::BoxFrustum() function.

virtual bool iRenderView::TestBSphere const csReversibleTransform   w2c,
const csSphere   sphere
[pure virtual]
 

Test if the given bounding sphere (in world space coordinates) is visible in this render view.

The optional will transform world to camera space.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18