dePropFieldGround Class Reference

Prop Field Ground. More...

#include <dePropFieldGround.h>

List of all members.

Public Member Functions
Constructors and Destructors
	dePropFieldGround ()
	Creates a new prop field ground.
	~dePropFieldGround ()
	Cleans up the prop field ground.
Management
void	Clear ()
	Clears the ground of the height terrain and all terrains and components.
deHeightTerrain *	GetHeightTerrain () const
	Retrieves the height terrain or NULL if not set.
void	SetHeightTerrain (deHeightTerrain *heightTerrain)
	Sets the height terrain or NULL if not set.
Components
int	GetComponentCount () const
	Retrieves the number of components.
deComponent *	GetComponentAt (int index) const
	Retrieves the component at the given index.
int	IndexOfComponent (deComponent *component) const
	Retrieves the index of the given component or -1 if not found.
bool	HasComponent (deComponent *component) const
	Determines if the given component exists.
void	AddComponent (deComponent *component)
	Adds a component.
void	RemoveComponent (deComponent *component)
	Removes a component.
void	RemoveAllComponents ()
	Removes all components.

---

Detailed Description

Prop Field Ground.

Defines the ground for instances of a prop field to be projected upon. This list contains components as well as the height terrain making up the ground. This list is used by the physics module to project prop field instances onto the ground. This list is designed to be used for a short time to align instances added to a prop field and is afterwards released. components are held by the prop field ground. Since this object is designed to live only for a short time no reference counting is used.

Author:

Plüss Roland

Version:

1.0

Date:

2009

---

Constructor & Destructor Documentation

dePropFieldGround::dePropFieldGround

(

)

Creates a new prop field ground.

dePropFieldGround::~dePropFieldGround

(

)

Cleans up the prop field ground.

---

Member Function Documentation

void dePropFieldGround::AddComponent

(

deComponent *

component )

Adds a component.

void dePropFieldGround::Clear

(

)

Clears the ground of the height terrain and all terrains and components.

deComponent* dePropFieldGround::GetComponentAt

(

int

index )

const

Retrieves the component at the given index.

int dePropFieldGround::GetComponentCount

(

)

const [inline]

Retrieves the number of components.

deHeightTerrain* dePropFieldGround::GetHeightTerrain

(

)

const [inline]

Retrieves the height terrain or NULL if not set.

bool dePropFieldGround::HasComponent

(

deComponent *

component )

const

Determines if the given component exists.

int dePropFieldGround::IndexOfComponent

(

deComponent *

component )

const

Retrieves the index of the given component or -1 if not found.

void dePropFieldGround::RemoveAllComponents

(

)

Removes all components.

void dePropFieldGround::RemoveComponent

(

deComponent *

component )

Removes a component.

void dePropFieldGround::SetHeightTerrain

(

deHeightTerrain *

heightTerrain )

Sets the height terrain or NULL if not set.

---

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

• dePropFieldGround.h