makVrv::DtForest Class Reference

A wrapper around the forest driver and some local state of the forest. More...

Public Member Functions
	DtForest (DtAgentManagerInterface &smi)
	CTOR.
	~DtForest ()
	DTOR.
void	setClippingPlanes (float farPlane)
	Set the clipping planes for the forest.
void	getClippingPlanes (float &farPlane) const
	Get the clipping planes for the forest.
void	set3DLodDistances (float nearLOD, float farLOD)
	Set the LOD distances for the trees.
void	get3DLodDistances (float &nearLOD, float &farLOD) const
	Get the LOD distances for the trees.
void	setBillboardDistances (float fStart, float fEnd)
	Set the Billboard distances for the trees.
void	getBillboardDistances (float &fStart, float &fEnd) const
	Get the Billboard distances for the trees.
void	addTree (const DtTreeRecord &record)
	Add a tree to the forest.
void	removeTree (const DtTreeRecord &record)
	Removes a tree from the forest.
void	addTree (const DtProp &prop)
	Add a tree to the forest.
void	setSpeedTreeSettings (DtTreeRecord &treeRecord, const DtTerrainTreeSettings *terrainTreeSettings)
	set the speed tree setting according to the terrains settings (scale and orientation)
void	setScaleAndOrientation (DtTreeRecord &treeRecord, const bool isTreeScaleRandomizationEnabled, const float minScale, const float maxScale, const bool isTreeOrientationRandomizationEnabled)
	set scale and orientation (Only implemented for Speed Trees)
void	removeTree (const DtProp &propID)
	Removes a tree from the forest.
void	removeTree (const DtUniqueID &uniqueId)
	Removes a tree from the forest.
void	removeAllTrees ()
	Remove all trees.
DtForestObjectAgent *	driver ()
	Get the forest driver. Typically you should not need to call this.

Protected Attributes
DtAgentManagerInterface &	mySceneInterface
DtForestObjectAgent *	myForestAgent
float	myFarPlane
float	myHighDetail3DDistance
float	myLowDetail3DDistance
float	myBillboardStartDistance
float	myBillboardEndDistance

Detailed Description

A wrapper around the forest driver and some local state of the forest.

Constructor & Destructor Documentation

makVrv::DtForest::DtForest

(

DtAgentManagerInterface &

smi

)

CTOR.

makVrv::DtForest::~DtForest

(

)

DTOR.

Member Function Documentation

void makVrv::DtForest::setClippingPlanes

(

float

farPlane

)

Set the clipping planes for the forest.

void makVrv::DtForest::getClippingPlanes

(

float &

farPlane

)

const

Get the clipping planes for the forest.

void makVrv::DtForest::set3DLodDistances	(	float	nearLOD,
		float	farLOD
	)

Set the LOD distances for the trees.

void makVrv::DtForest::get3DLodDistances	(	float &	nearLOD,
		float &	farLOD
	)		const

Get the LOD distances for the trees.

void makVrv::DtForest::setBillboardDistances	(	float	fStart,
		float	fEnd
	)

Set the Billboard distances for the trees.

void makVrv::DtForest::getBillboardDistances	(	float &	fStart,
		float &	fEnd
	)		const

Get the Billboard distances for the trees.

void makVrv::DtForest::addTree

(

const DtTreeRecord &

record

)

Add a tree to the forest.

void makVrv::DtForest::removeTree

(

const DtTreeRecord &

record

)

Removes a tree from the forest.

void makVrv::DtForest::addTree

(

const DtProp &

prop

)

Add a tree to the forest.

void makVrv::DtForest::setSpeedTreeSettings	(	DtTreeRecord &	treeRecord,
		const DtTerrainTreeSettings *	terrainTreeSettings
	)

set the speed tree setting according to the terrains settings (scale and orientation)

void makVrv::DtForest::setScaleAndOrientation	(	DtTreeRecord &	treeRecord,
		const bool	isTreeScaleRandomizationEnabled,
		const float	minScale,
		const float	maxScale,
		const bool	isTreeOrientationRandomizationEnabled
	)

set scale and orientation (Only implemented for Speed Trees)

void makVrv::DtForest::removeTree

(

const DtProp &

propID

)

Removes a tree from the forest.

void makVrv::DtForest::removeTree

(

const DtUniqueID &

uniqueId

)

Removes a tree from the forest.

void makVrv::DtForest::removeAllTrees

(

)

Remove all trees.

DtForestObjectAgent* makVrv::DtForest::driver

(

)

Get the forest driver. Typically you should not need to call this.

Member Data Documentation

DtAgentManagerInterface& makVrv::DtForest::mySceneInterface

protected

DtForestObjectAgent* makVrv::DtForest::myForestAgent

protected

float makVrv::DtForest::myFarPlane

protected

float makVrv::DtForest::myHighDetail3DDistance

protected

float makVrv::DtForest::myLowDetail3DDistance

protected

float makVrv::DtForest::myBillboardStartDistance

protected

float makVrv::DtForest::myBillboardEndDistance

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtForest.h