Forest

consoledoc.h

Forest is a global-bounds scene object provides collision and rendering for a (.forest) data file.

More...

Lod

float

Scalar applied to the farclip distance when Forest renders into a reflection.

Public Static Attributes

bool

A debugging aid which will disable rendering of all imposters in the forest.

bool

A debugging aid which renders the forest bounds.

bool

A debugging aid which renders the forest cell bounds.

bool

A debugging aid which will force all forest items to be rendered as imposters.

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Public Attributes

filename

The source forest data file.

Public Functions

void
bool
void
void
saveDataFile(string path)

saveDataFile( [path] )

Detailed Description

Forest is a global-bounds scene object provides collision and rendering for a (.forest) data file.

Forest is designed to efficiently render a large number of static meshes: trees, rocks plants, etc. These cannot be moved at game-time or play animations but do support wind effects using vertex shader transformations guided by vertex color in the asset and user placed wind emitters ( or weapon explosions ).

Script level manipulation of forest data is not possible through Forest, it is only the rendering/collision. All editing is done through the world editor.

see:

TSForestItemData Defines a tree type.

see:

GuiForestEditorCtrl Used by the world editor to provide manipulation of forest data.

Lod

float lodReflectScalar 

Scalar applied to the farclip distance when Forest renders into a reflection.

Public Static Attributes

bool disableImposters 

A debugging aid which will disable rendering of all imposters in the forest.

bool drawBounds 

A debugging aid which renders the forest bounds.

bool drawCells 

A debugging aid which renders the forest cell bounds.

bool forceImposters 

A debugging aid which will force all forest items to be rendered as imposters.

bool isRenderable 

Disables rendering of all instances of this type.

bool isSelectable 

Disables selection of all instances of this type.

Public Attributes

filename dataFile 

The source forest data file.

Public Functions

clear()

isDirty()

regenCells()

saveDataFile(string path)

saveDataFile( [path] )