Main   Class List   Namespace List   Wiki

Forest Class Reference
[Forest]

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

Inheritance diagram for Forest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void clear ()
bool isDirty ()
void regenCells ()

Public Attributes

filename dataFile
 The source forest data file.
bool saveDataFile
 saveDataFile( [path] )
Lod

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

Static Public Attributes

static bool disableImposters
 A debugging aid which will disable rendering of all imposters in the forest.
static bool drawBounds
 A debugging aid which renders the forest bounds.
static bool drawCells
 A debugging aid which renders the forest cell bounds.
static bool forceImposters
 A debugging aid which will force all forest items to be rendered as imposters.
static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

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 also:
TSForestItemData Defines a tree type.
GuiForestEditorCtrl Used by the world editor to provide manipulation of forest data.

Member Function Documentation

void Forest::clear (  ) 
bool Forest::isDirty (  ) 
void Forest::regenCells (  ) 

Member Data Documentation

filename Forest::dataFile

The source forest data file.

bool Forest::isRenderable [static]

Disables rendering of all instances of this type.

Reimplemented from SceneObject.

bool Forest::isSelectable [static]

Disables selection of all instances of this type.

Reimplemented from SceneObject.

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

saveDataFile( [path] )



Copyright © GarageGames, LLC. All Rights Reserved.