Pyrogenesis  trunk
Public Member Functions | Protected Attributes | List of all members
InstancingModelRenderer Class Reference

Render non-animated (but potentially moving) models using a ShaderRenderModifier. More...

#include <InstancingModelRenderer.h>

Inheritance diagram for InstancingModelRenderer:
Inheritance graph
[legend]
Collaboration diagram for InstancingModelRenderer:
Collaboration graph
[legend]

Public Member Functions

 InstancingModelRenderer (bool gpuSkinning, bool calculateTangents)
 
 ~InstancingModelRenderer ()
 
CModelRDataCreateModelData (const void *key, CModel *model)
 CreateModelData: Create internal data for one model. More...
 
void UpdateModelData (CModel *model, CModelRData *data, int updateflags)
 UpdateModelData: Calculate per-model data for each frame. More...
 
void BeginPass (int streamflags)
 BeginPass: Setup global OpenGL state for this ModelVertexRenderer. More...
 
void EndPass (int streamflags)
 EndPass: Cleanup OpenGL state set up by BeginPass. More...
 
void PrepareModelDef (const CShaderProgramPtr &shader, int streamflags, const CModelDef &def)
 PrepareModelDef: Setup OpenGL state for rendering of models that use the given CModelDef object as base. More...
 
void RenderModel (const CShaderProgramPtr &shader, int streamflags, CModel *model, CModelRData *data)
 RenderModel: Invoke the rendering commands for the given model. More...
 
- Public Member Functions inherited from ModelVertexRenderer
virtual ~ModelVertexRenderer ()
 

Protected Attributes

InstancingModelRendererInternalsm
 

Detailed Description

Render non-animated (but potentially moving) models using a ShaderRenderModifier.

This computes and binds per-vertex data; the modifier is responsible for setting any shader uniforms etc (including the instancing transform).

Constructor & Destructor Documentation

InstancingModelRenderer::InstancingModelRenderer ( bool  gpuSkinning,
bool  calculateTangents 
)
InstancingModelRenderer::~InstancingModelRenderer ( )

Member Function Documentation

void InstancingModelRenderer::BeginPass ( int  streamflags)
virtual

BeginPass: Setup global OpenGL state for this ModelVertexRenderer.

ModelVertexRenderer implementations should prepare "heavy" OpenGL state such as vertex shader state to prepare for rendering models and delivering vertex data to the fragment stage as described by streamflags.

ModelRenderer implementations must call this function before any calls to other rendering related functions.

Recursive calls to BeginPass are not allowed, and every BeginPass is matched by a corresponding call to EndPass.

Parameters
streamflagsVertex streams required by the fragment stage.

Implements ModelVertexRenderer.

CModelRData * InstancingModelRenderer::CreateModelData ( const void *  key,
CModel model 
)
virtual

CreateModelData: Create internal data for one model.

ModelRenderer implementations must call this once for every model that will later be rendered, with key set to a value that's unique to that ModelRenderer.

ModelVertexRenderer implementations should use this function to create per-CModel and per-CModelDef data like vertex arrays.

Parameters
keyAn opaque pointer to pass to the CModelRData constructor
modelThe model.
Returns
A new CModelRData that will be passed into other ModelVertexRenderer functions whenever the same CModel is used again.

Implements ModelVertexRenderer.

void InstancingModelRenderer::EndPass ( int  streamflags)
virtual

EndPass: Cleanup OpenGL state set up by BeginPass.

ModelRenderer implementations must call this function after rendering related functions for one pass have been called.

Parameters
streamflagsVertex streams required by the fragment stage. This equals the streamflags parameter passed on the last call to BeginPass.

Implements ModelVertexRenderer.

void InstancingModelRenderer::PrepareModelDef ( const CShaderProgramPtr shader,
int  streamflags,
const CModelDef def 
)
virtual

PrepareModelDef: Setup OpenGL state for rendering of models that use the given CModelDef object as base.

ModelRenderer implementations must call this function before rendering a sequence of models based on the given CModelDef. When a ModelRenderer switches back and forth between CModelDefs, it must call PrepareModelDef for every switch.

Parameters
streamflagsVertex streams required by the fragment stage. This equals the streamflags parameter passed on the last call to BeginPass.
defThe model definition.

Implements ModelVertexRenderer.

void InstancingModelRenderer::RenderModel ( const CShaderProgramPtr shader,
int  streamflags,
CModel model,
CModelRData data 
)
virtual

RenderModel: Invoke the rendering commands for the given model.

ModelRenderer implementations must call this function to perform the actual rendering.

preconditions : The most recent call to PrepareModelDef since BeginPass has been for model->GetModelDef().

Parameters
streamflagsVertex streams required by the fragment stage. This equals the streamflags parameter passed on the last call to BeginPass.
modelThe model that should be rendered.
dataPrivate data for the model as returned by CreateModelData.

postconditions : Subsequent calls to RenderModel for models that use the same CModelDef object and the same texture must succeed.

Implements ModelVertexRenderer.

void InstancingModelRenderer::UpdateModelData ( CModel model,
CModelRData data,
int  updateflags 
)
virtual

UpdateModelData: Calculate per-model data for each frame.

ModelRenderer implementations must call this once per frame for every model that is to be rendered in this frame, even if the value of updateflags will be zero. This implies that this function will also be called at least once between a call to CreateModelData and a call to RenderModel.

ModelVertexRenderer implementations should use this function to perform software vertex transforms and potentially other per-frame calculations.

Parameters
modelThe model.
dataPrivate data as returned by CreateModelData.
updateflagsFlags indicating which data has changed during the frame. The value is the same as the value of the model's CRenderData::m_UpdateFlags.

Implements ModelVertexRenderer.

Member Data Documentation

InstancingModelRendererInternals* InstancingModelRenderer::m
protected

The documentation for this class was generated from the following files: