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. More...
	~DtForest ()
	DTOR. More...
void	setClippingPlanes (float farPlane)
	Set the clipping planes for the forest. More...
void	getClippingPlanes (float &farPlane) const
	Get the clipping planes for the forest. More...
void	set3DLodDistances (float nearLOD, float farLOD)
	Set the LOD distances for the trees. More...
void	get3DLodDistances (float &nearLOD, float &farLOD) const
	Get the LOD distances for the trees. More...
void	setBillboardDistances (float fStart, float fEnd)
	Set the Billboard distances for the trees. More...
void	setBillboardFadeOutRange (float range)
	set the fade out distance for the billboards. The Range - Cull distance = start transition dist More...
void	getBillboardDistances (float &fStart, float &fEnd) const
	Get the Billboard distances for the trees. More...
void	addTree (const DtTreeRecord &record)
	Add a tree to the forest. More...
void	removeTree (const DtTreeRecord &record)
	Removes a tree from the forest. More...
void	addTree (const DtProp &prop)
	Add a tree to the forest. More...
void	setSpeedTreeSettings (DtTreeRecord &treeRecord, const DtTerrainTreeSettings *terrainTreeSettings)
	set the speed tree setting according to the terrains settings (scale and orientation) More...
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) More...
void	removeTree (const DtProp &propID)
	Removes a tree from the forest. More...
void	removeTree (const DtUniqueID &uniqueId)
	Removes a tree from the forest. More...
void	removeAllTrees ()
	Remove all trees. More...
DtForestObjectAgent *	driver ()
	Get the forest driver. Typically you should not need to call this. More...

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

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::setBillboardFadeOutRange

(

float

range

)

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

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

float makVrv::DtForest::myBillboardFadeOutRange

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtForest.h