Prop Field. More...
#include <dePropField.h>
Public Member Functions | |
Constructors and Destructors | |
| dePropField (dePropFieldManager *manager) | |
| Creates a new prop field. | |
| virtual | ~dePropField () |
| Cleans up the prop field. | |
Management | |
| const decDVector & | GetPosition () const |
| Retrieves the position. | |
| void | SetPosition (const decDVector &position) |
| Sets the position. | |
| int | GetTypeCount () const |
| Retrieves the number of types. | |
| dePropFieldType * | GetTypeAt (int index) const |
| Retrieves the type at the given index. | |
| int | IndexOfType (dePropFieldType *type) const |
| Retrieves the index of the given type of -1 if not found. | |
| void | AddType (dePropFieldType *type) |
| Adds a type. | |
| void | RemoveType (dePropFieldType *type) |
| Removes the given type. | |
| void | RemoveAllTypes () |
| Removes all types. | |
| void | NotifyTypeChanged (int type) |
| Notifies the peers that the given type changed. | |
| void | NotifyInstancesChanged (int type) |
| Notifies the peers that the given type instances changed. | |
| void | NotifyAssignmentsChanged (int type) |
| Notifies the peers that the given type instances to bend states assignments changed. | |
| void | NotifyBendStatesChanged (int type) |
| Notifies the peers that the given type bend states changed. | |
| void | NotifyGroundChanged () |
| Notifies the graphic module that the ground changed. | |
| void | NotifyCreateInstances (float density) |
| Requests the scripting module to create instances using the given density. | |
| void | NotifyProjectInstances (const dePropFieldGround &ground, const decVector &direction) |
| Requests the physics module to project all instances to the given ground. | |
System Peers | |
| deBaseGraphicPropField * | GetGraphicPropField () const |
| Retrieves the graphic system peer object. | |
| void | SetGraphicPropField (deBaseGraphicPropField *peer) |
| Sets the graphic system peer object. | |
| deBasePhysicsPropField * | GetPhysicsPropField () const |
| Retrieves the physics system peer object. | |
| void | SetPhysicsPropField (deBasePhysicsPropField *peer) |
| Sets the physics system peer object. | |
| deBaseScriptingPropField * | GetScriptingPropField () const |
| Retrieves the scripting system peer object. | |
| void | SetScriptingPropField (deBaseScriptingPropField *peer) |
| Sets the scripting system peer object. | |
Detailed Description
Prop Field.
Prop fields define a large number of inexpensive models used to populate with vegetation or props in general for improved visuals. These props are not required to be rendered or simulated in a physical way for the game to work. Prop fields have a couple of restrictions on how these props are defined to create large numbers of props with little definition, processing and memory overhead. Each prop field contains a list of types.
- Version:
- 1.0
- Date:
- 2009
Constructor & Destructor Documentation
| dePropField::dePropField | ( | dePropFieldManager * | manager ) |
Creates a new prop field.
| virtual dePropField::~dePropField | ( | ) | [virtual] |
Cleans up the prop field.
Member Function Documentation
| void dePropField::AddType | ( | dePropFieldType * | type ) |
Adds a type.
| deBaseGraphicPropField* dePropField::GetGraphicPropField | ( | ) | const [inline] |
Retrieves the graphic system peer object.
| deBasePhysicsPropField* dePropField::GetPhysicsPropField | ( | ) | const [inline] |
Retrieves the physics system peer object.
| const decDVector& dePropField::GetPosition | ( | ) | const [inline] |
Retrieves the position.
| deBaseScriptingPropField* dePropField::GetScriptingPropField | ( | ) | const [inline] |
Retrieves the scripting system peer object.
| dePropFieldType* dePropField::GetTypeAt | ( | int | index ) | const |
Retrieves the type at the given index.
| int dePropField::GetTypeCount | ( | ) | const [inline] |
Retrieves the number of types.
| int dePropField::IndexOfType | ( | dePropFieldType * | type ) | const |
Retrieves the index of the given type of -1 if not found.
| void dePropField::NotifyAssignmentsChanged | ( | int | type ) |
Notifies the peers that the given type instances to bend states assignments changed.
| void dePropField::NotifyBendStatesChanged | ( | int | type ) |
Notifies the peers that the given type bend states changed.
| void dePropField::NotifyCreateInstances | ( | float | density ) |
Requests the scripting module to create instances using the given density.
| void dePropField::NotifyGroundChanged | ( | ) |
Notifies the graphic module that the ground changed.
| void dePropField::NotifyInstancesChanged | ( | int | type ) |
Notifies the peers that the given type instances changed.
| void dePropField::NotifyProjectInstances | ( | const dePropFieldGround & | ground, |
| const decVector & | direction | ||
| ) |
Requests the physics module to project all instances to the given ground.
| void dePropField::NotifyTypeChanged | ( | int | type ) |
Notifies the peers that the given type changed.
| void dePropField::RemoveAllTypes | ( | ) |
Removes all types.
| void dePropField::RemoveType | ( | dePropFieldType * | type ) |
Removes the given type.
| void dePropField::SetGraphicPropField | ( | deBaseGraphicPropField * | peer ) |
Sets the graphic system peer object.
| void dePropField::SetPhysicsPropField | ( | deBasePhysicsPropField * | peer ) |
Sets the physics system peer object.
| void dePropField::SetPosition | ( | const decDVector & | position ) |
Sets the position.
| void dePropField::SetScriptingPropField | ( | deBaseScriptingPropField * | peer ) |
Sets the scripting system peer object.
The documentation for this class was generated from the following file:
