deWorld Class Reference

Renderable World Class. More...

#include <deWorld.h>

Inheritance diagram for deWorld:
deResource deObject

List of all members.

Public Member Functions

Constructors and Destructors
 deWorld (deWorldManager *manager)
 Creates a new world object with the given resource manager.
 ~deWorld ()
 Cleans up the world.
Management
void Clear ()
 Removes all objects from the world.
deSkyGetSky () const
 Retrieves the assigned sky or NULL.
void SetSky (deSky *sky)
 Sets the assigned sky or NULL to remove it.
deHeightTerrainGetHeightTerrain () const
 Retrieves the assigned height terrain or NULL.
void SetHeightTerrain (deHeightTerrain *heightTerrain)
 Sets the assigned height terrain or NULL to remove it.
const decDVectorGetSize () const
 Retrieves the size of the world.
void SetSize (const decDVector &size)
 Sets the size of the world.
const decVectorGetGravity () const
 Retrieves the world gravity vector.
void SetGravity (const decVector &gravity)
 Sets the world gravity vector.
bool GetDisableLights () const
 Determines if all lights are disables.
void SetDisableLights (bool disable)
 Sets if all lights are disabled.
const decColorGetAmbientLight () const
 Retrieves the ambient light color.
void SetAmbientLight (const decColor &color)
 Sets the ambient light color.
const decMatrixGetLightColorMatrix () const
 Retrieves the light color matrix.
void SetLightColorMatrix (const decMatrix &matrix)
 Sets the light color matrix.
void Update (float elapsed)
 Updates dynamic world parts.
Cameras Management
int GetCameraCount () const
 Retrieves the count of cameras.
deCameraGetCameraAt (int index) const
 Retrieves the camera at the given index.
int IndexOfCamera (deCamera *camera) const
 Retrieves the index of the given camera of -1 if not found.
void AddCamera (deCamera *camera)
 Adds a camera to the world.
void RemoveCamera (deCamera *camera)
 Removes the given camera from the world.
void RemoveAllCameras ()
 Removes all cameras from the world.
Speakers Management
int GetSpeakerCount () const
 Retrieves the count of speakers.
deSpeakerGetSpeakerAt (int index) const
 Retrieves the speaker at the given index.
int IndexOfSpeaker (deSpeaker *speaker) const
 Retrieves the index of the given speaker of -1 if not found.
void AddSpeaker (deSpeaker *speaker)
 Adds a speaker to the world.
void RemoveSpeaker (deSpeaker *speaker)
 Removes the given speaker from the world.
void RemoveAllSpeakers ()
 Removes all speakers from the world.
Microphones Management
int GetMicrophoneCount () const
 Retrieves the count of microphones.
deMicrophoneGetMicrophoneAt (int index) const
 Retrieves the microphone at the given index.
int IndexOfMicrophone (deMicrophone *microphone) const
 Retrieves the index of the given microphone of -1 if not found.
void AddMicrophone (deMicrophone *microphone)
 Adds a microphone to the world.
void RemoveMicrophone (deMicrophone *microphone)
 Removes the given microphone from the world.
void RemoveAllMicrophones ()
 Removes all microphones from the world.
NetworkStates Management
int GetNetworkStateCount () const
 Retrieves the count of networkStates.
deNetworkStateGetNetworkStateAt (int index) const
 Retrieves the networkState at the given index.
int IndexOfNetworkState (deNetworkState *networkState) const
 Retrieves the index of the given networkState of -1 if not found.
void AddNetworkState (deNetworkState *networkState)
 Adds a networkState to the world.
void RemoveNetworkState (deNetworkState *networkState)
 Removes the given networkState from the world.
void RemoveAllNetworkStates ()
 Removes all networkStates from the world.
Lights Management
int GetLightCount () const
 Retrieves the count of lights.
deLightGetLight (int index) const
 Retrieves the light at the given index.
void AddLight (deLight *light)
 Adds a light to the world.
void RemoveLight (deLight *light)
 Removes the given light from the world.
void RemoveAllLights ()
 Removes all lights from the world.
Collider Management
int GetColliderCount () const
 Retrieves the count of colliders.
deColliderGetCollider (int index) const
 Retrieves the collider at the given index.
int IndexOfCollider (deCollider *collider) const
 Retrieves the index of the given collider or -1 if not found.
bool HasCollider (deCollider *collider) const
 Determines if the given collider exists.
void AddCollider (deCollider *collider)
 Adds a collider to the world.
void RemoveCollider (deCollider *collider)
 Removes the given collider from the world.
void RemoveAllColliders ()
 Removes all colliders from the world.
DebugDrawer Management
int GetDebugDrawerCount () const
 Retrieves the count of debugDrawers.
deDebugDrawerGetDebugDrawerAt (int index) const
 Retrieves the debugDrawer at the given index.
void AddDebugDrawer (deDebugDrawer *debugDrawer)
 Adds a debugDrawer to the world.
void RemoveDebugDrawer (deDebugDrawer *debugDrawer)
 Removes the given debugDrawer from the world.
void RemoveAllDebugDrawers ()
 Removes all debugDrawers from the world.
Lumimeters Management
int GetLumimeterCount () const
 Retrieves the count of lumimeters.
deLumimeterGetLumimeterAt (int index) const
 Retrieves the lumimeter at the given index.
int IndexOfLumimeter (deLumimeter *lumimeter) const
 Retrieves the index of the given lumimeter of -1 if not found.
void AddLumimeter (deLumimeter *lumimeter)
 Adds a lumimeter to the world.
void RemoveLumimeter (deLumimeter *lumimeter)
 Removes the given lumimeter from the world.
void RemoveAllLumimeters ()
 Removes all lumimeters from the world.
Touch Sensors Management
int GetTouchSensorCount () const
 Retrieves the count of touch sensors.
deTouchSensorGetTouchSensorAt (int index) const
 Retrieves the touch sensor at the given index.
int IndexOfTouchSensor (deTouchSensor *touchSensor) const
 Retrieves the index of the given touch sensor of -1 if not found.
void AddTouchSensor (deTouchSensor *touchSensor)
 Adds a touchSensor to the world.
void RemoveTouchSensor (deTouchSensor *touchSensor)
 Removes the given touch sensors from the world.
void RemoveAllTouchSensors ()
 Removes all touch sensors from the world.
Prop Fields Management
int GetPropFieldCount () const
 Retrieves the count of prop fields.
dePropFieldGetPropFieldAt (int index) const
 Retrieves the prop field at the given index.
int IndexOfPropField (dePropField *propField) const
 Retrieves the index of the given prop field of -1 if not found.
void AddPropField (dePropField *propField)
 Adds a prop field to the world.
void RemovePropField (dePropField *propField)
 Removes the given prop fields from the world.
void RemoveAllPropFields ()
 Removes all prop fields from the world.
Force Fields Management
int GetForceFieldCount () const
 Retrieves the count of force fields.
deForceFieldGetForceFieldAt (int index) const
 Retrieves the force field at the given index.
int IndexOfForceField (deForceField *forceField) const
 Retrieves the index of the given force field of -1 if not found.
void AddForceField (deForceField *forceField)
 Adds a forceField to the world.
void RemoveForceField (deForceField *forceField)
 Removes the given force fields from the world.
void RemoveAllForceFields ()
 Removes all force fields from the world.
Component Management
int GetComponentCount () const
 Retrieves the count of components.
deComponentGetComponent (int index) const
 Retrieves the component at the given index.
void AddComponent (deComponent *comp)
 Adds a component to the world.
void RemoveComponent (deComponent *comp)
 Removes a component from the world.
void RemoveAllComponents ()
 Removes all components from the world.
Particle Emitters.
int GetParticleEmitterCount () const
 Retrieves the number of particle emitters.
deParticleEmitterGetRootParticleEmitter () const
 Retrieves the root particle emitter or NULL if there is none.
void AddParticleEmitter (deParticleEmitter *emitter)
 Adds a particle emitter.
void RemoveParticleEmitter (deParticleEmitter *emitter)
 Removes a particle emitter.
void RemoveAllParticleEmitters ()
 Removes all particle emitters.
Smoke Emitters.
int GetSmokeEmitterCount () const
 Retrieves the count of smoke emitters.
deSmokeEmitterGetSmokeEmitterAt (int index) const
 Retrieves the smoke emitter at the given index.
int IndexOfSmokeEmitter (deSmokeEmitter *smokeEmitter) const
 Retrieves the index of the given smoke emitter of -1 if not found.
void AddSmokeEmitter (deSmokeEmitter *smokeEmitter)
 Adds a smoke emitter to the world.
void RemoveSmokeEmitter (deSmokeEmitter *smokeEmitter)
 Removes the given smoke emitters from the world.
void RemoveAllSmokeEmitters ()
 Removes all smoke emitters from the world.
Occluders.
int GetOccluderCount () const
 Retrieves the number of occluders.
deOccluderGetOccluderAt (int index) const
 Retrieves the occluder at the given index.
int IndexOfOccluder (deOccluder *occluder) const
 Retrieves the index of the given occluder of -1 if not found.
void AddOccluder (deOccluder *occluder)
 Adds a occluder to the world.
void RemoveOccluder (deOccluder *occluder)
 Removes the given occluder from the world.
void RemoveAllOccluders ()
 Removes all occluders from the world.
Portal Systems.
int GetPortalSystemCount () const
 Retrieves the number of portal systems.
dePortalSystemGetPortalSystemAt (int index) const
 Retrieves the portal system at the given index.
int IndexOfPortalSystem (dePortalSystem *portalSystem) const
 Retrieves the index of the given portal system or -1 if not found.
void AddPortalSystem (dePortalSystem *portalSystem)
 Adds a portal system to the world.
void RemovePortalSystem (dePortalSystem *portalSystem)
 Removes the given portal system from the world.
void RemoveAllPortalSystems ()
 Removes all portal systems from the world.
Billboards.
int GetBillboardCount () const
 Retrieves the number of billboards.
deBillboardGetRootBillboard () const
 Retrieves the root billboard or NULL if there is none.
void AddBillboard (deBillboard *billboard)
 Adds a billboard.
void RemoveBillboard (deBillboard *billboard)
 Removes a billboard.
void RemoveAllBillboards ()
 Removes all billboards.
System Peers
deBaseGraphicWorldGetGraphicWorld () const
 Retrieves the graphic system peer object.
void SetGraphicWorld (deBaseGraphicWorld *graWorld)
 Sets the graphic system peer object.
deBasePhysicsWorldGetPhysicsWorld () const
 Retrieves the physics system peer object.
void SetPhysicsWorld (deBasePhysicsWorld *phyWorld)
 Sets the physics system peer object.
deBaseAudioWorldGetAudioWorld () const
 Retrieves the audio system peer object.
void SetAudioWorld (deBaseAudioWorld *audWorld)
 Sets the audio system peer object.
deBaseNetworkWorldGetNetworkWorld () const
 Retrieves the audio system peer object.
void SetNetworkWorld (deBaseNetworkWorld *netWorld)
 Sets the audio system peer object.

Detailed Description

Renderable World Class.

Worlds are the top most class for rendering 3d worldries. They bundle a set of World objects and a Sky object. Besides rendering they also are able to do collision detection and physical responses to them.

Author:
Plüss Roland
Version:
1.0
Date:
2008

Constructor & Destructor Documentation

deWorld::deWorld ( deWorldManager manager )

Creates a new world object with the given resource manager.

deWorld::~deWorld (  )

Cleans up the world.


Member Function Documentation

void deWorld::AddBillboard ( deBillboard billboard )

Adds a billboard.

void deWorld::AddCamera ( deCamera camera )

Adds a camera to the world.

void deWorld::AddCollider ( deCollider collider )

Adds a collider to the world.

void deWorld::AddComponent ( deComponent comp )

Adds a component to the world.

void deWorld::AddDebugDrawer ( deDebugDrawer debugDrawer )

Adds a debugDrawer to the world.

void deWorld::AddForceField ( deForceField forceField )

Adds a forceField to the world.

void deWorld::AddLight ( deLight light )

Adds a light to the world.

void deWorld::AddLumimeter ( deLumimeter lumimeter )

Adds a lumimeter to the world.

void deWorld::AddMicrophone ( deMicrophone microphone )

Adds a microphone to the world.

void deWorld::AddNetworkState ( deNetworkState networkState )

Adds a networkState to the world.

void deWorld::AddOccluder ( deOccluder occluder )

Adds a occluder to the world.

void deWorld::AddParticleEmitter ( deParticleEmitter emitter )

Adds a particle emitter.

void deWorld::AddPortalSystem ( dePortalSystem portalSystem )

Adds a portal system to the world.

void deWorld::AddPropField ( dePropField propField )

Adds a prop field to the world.

void deWorld::AddSmokeEmitter ( deSmokeEmitter smokeEmitter )

Adds a smoke emitter to the world.

void deWorld::AddSpeaker ( deSpeaker speaker )

Adds a speaker to the world.

void deWorld::AddTouchSensor ( deTouchSensor touchSensor )

Adds a touchSensor to the world.

void deWorld::Clear (  )

Removes all objects from the world.

const decColor& deWorld::GetAmbientLight (  ) const [inline]

Retrieves the ambient light color.

deBaseAudioWorld* deWorld::GetAudioWorld (  ) const [inline]

Retrieves the audio system peer object.

int deWorld::GetBillboardCount (  ) const [inline]

Retrieves the number of billboards.

deCamera* deWorld::GetCameraAt ( int  index ) const

Retrieves the camera at the given index.

int deWorld::GetCameraCount (  ) const [inline]

Retrieves the count of cameras.

deCollider* deWorld::GetCollider ( int  index ) const

Retrieves the collider at the given index.

int deWorld::GetColliderCount (  ) const [inline]

Retrieves the count of colliders.

deComponent* deWorld::GetComponent ( int  index ) const

Retrieves the component at the given index.

int deWorld::GetComponentCount (  ) const [inline]

Retrieves the count of components.

deDebugDrawer* deWorld::GetDebugDrawerAt ( int  index ) const

Retrieves the debugDrawer at the given index.

int deWorld::GetDebugDrawerCount (  ) const [inline]

Retrieves the count of debugDrawers.

bool deWorld::GetDisableLights (  ) const [inline]

Determines if all lights are disables.

deForceField* deWorld::GetForceFieldAt ( int  index ) const

Retrieves the force field at the given index.

int deWorld::GetForceFieldCount (  ) const [inline]

Retrieves the count of force fields.

deBaseGraphicWorld* deWorld::GetGraphicWorld (  ) const [inline]

Retrieves the graphic system peer object.

const decVector& deWorld::GetGravity (  ) const [inline]

Retrieves the world gravity vector.

deHeightTerrain* deWorld::GetHeightTerrain (  ) const [inline]

Retrieves the assigned height terrain or NULL.

deLight* deWorld::GetLight ( int  index ) const

Retrieves the light at the given index.

const decMatrix& deWorld::GetLightColorMatrix (  ) const [inline]

Retrieves the light color matrix.

int deWorld::GetLightCount (  ) const [inline]

Retrieves the count of lights.

deLumimeter* deWorld::GetLumimeterAt ( int  index ) const

Retrieves the lumimeter at the given index.

int deWorld::GetLumimeterCount (  ) const [inline]

Retrieves the count of lumimeters.

deMicrophone* deWorld::GetMicrophoneAt ( int  index ) const

Retrieves the microphone at the given index.

int deWorld::GetMicrophoneCount (  ) const [inline]

Retrieves the count of microphones.

deNetworkState* deWorld::GetNetworkStateAt ( int  index ) const

Retrieves the networkState at the given index.

int deWorld::GetNetworkStateCount (  ) const [inline]

Retrieves the count of networkStates.

deBaseNetworkWorld* deWorld::GetNetworkWorld (  ) const [inline]

Retrieves the audio system peer object.

deOccluder* deWorld::GetOccluderAt ( int  index ) const

Retrieves the occluder at the given index.

int deWorld::GetOccluderCount (  ) const [inline]

Retrieves the number of occluders.

int deWorld::GetParticleEmitterCount (  ) const [inline]

Retrieves the number of particle emitters.

deBasePhysicsWorld* deWorld::GetPhysicsWorld (  ) const [inline]

Retrieves the physics system peer object.

dePortalSystem* deWorld::GetPortalSystemAt ( int  index ) const

Retrieves the portal system at the given index.

int deWorld::GetPortalSystemCount (  ) const [inline]

Retrieves the number of portal systems.

dePropField* deWorld::GetPropFieldAt ( int  index ) const

Retrieves the prop field at the given index.

int deWorld::GetPropFieldCount (  ) const [inline]

Retrieves the count of prop fields.

deBillboard* deWorld::GetRootBillboard (  ) const [inline]

Retrieves the root billboard or NULL if there is none.

deParticleEmitter* deWorld::GetRootParticleEmitter (  ) const [inline]

Retrieves the root particle emitter or NULL if there is none.

const decDVector& deWorld::GetSize (  ) const [inline]

Retrieves the size of the world.

deSky* deWorld::GetSky (  ) const [inline]

Retrieves the assigned sky or NULL.

deSmokeEmitter* deWorld::GetSmokeEmitterAt ( int  index ) const

Retrieves the smoke emitter at the given index.

int deWorld::GetSmokeEmitterCount (  ) const [inline]

Retrieves the count of smoke emitters.

deSpeaker* deWorld::GetSpeakerAt ( int  index ) const

Retrieves the speaker at the given index.

int deWorld::GetSpeakerCount (  ) const [inline]

Retrieves the count of speakers.

deTouchSensor* deWorld::GetTouchSensorAt ( int  index ) const

Retrieves the touch sensor at the given index.

int deWorld::GetTouchSensorCount (  ) const [inline]

Retrieves the count of touch sensors.

bool deWorld::HasCollider ( deCollider collider ) const

Determines if the given collider exists.

int deWorld::IndexOfCamera ( deCamera camera ) const

Retrieves the index of the given camera of -1 if not found.

int deWorld::IndexOfCollider ( deCollider collider ) const

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

int deWorld::IndexOfForceField ( deForceField forceField ) const

Retrieves the index of the given force field of -1 if not found.

int deWorld::IndexOfLumimeter ( deLumimeter lumimeter ) const

Retrieves the index of the given lumimeter of -1 if not found.

int deWorld::IndexOfMicrophone ( deMicrophone microphone ) const

Retrieves the index of the given microphone of -1 if not found.

int deWorld::IndexOfNetworkState ( deNetworkState networkState ) const

Retrieves the index of the given networkState of -1 if not found.

int deWorld::IndexOfOccluder ( deOccluder occluder ) const

Retrieves the index of the given occluder of -1 if not found.

int deWorld::IndexOfPortalSystem ( dePortalSystem portalSystem ) const

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

int deWorld::IndexOfPropField ( dePropField propField ) const

Retrieves the index of the given prop field of -1 if not found.

int deWorld::IndexOfSmokeEmitter ( deSmokeEmitter smokeEmitter ) const

Retrieves the index of the given smoke emitter of -1 if not found.

int deWorld::IndexOfSpeaker ( deSpeaker speaker ) const

Retrieves the index of the given speaker of -1 if not found.

int deWorld::IndexOfTouchSensor ( deTouchSensor touchSensor ) const

Retrieves the index of the given touch sensor of -1 if not found.

void deWorld::RemoveAllBillboards (  )

Removes all billboards.

void deWorld::RemoveAllCameras (  )

Removes all cameras from the world.

void deWorld::RemoveAllColliders (  )

Removes all colliders from the world.

void deWorld::RemoveAllComponents (  )

Removes all components from the world.

void deWorld::RemoveAllDebugDrawers (  )

Removes all debugDrawers from the world.

void deWorld::RemoveAllForceFields (  )

Removes all force fields from the world.

void deWorld::RemoveAllLights (  )

Removes all lights from the world.

void deWorld::RemoveAllLumimeters (  )

Removes all lumimeters from the world.

void deWorld::RemoveAllMicrophones (  )

Removes all microphones from the world.

void deWorld::RemoveAllNetworkStates (  )

Removes all networkStates from the world.

void deWorld::RemoveAllOccluders (  )

Removes all occluders from the world.

void deWorld::RemoveAllParticleEmitters (  )

Removes all particle emitters.

void deWorld::RemoveAllPortalSystems (  )

Removes all portal systems from the world.

void deWorld::RemoveAllPropFields (  )

Removes all prop fields from the world.

void deWorld::RemoveAllSmokeEmitters (  )

Removes all smoke emitters from the world.

void deWorld::RemoveAllSpeakers (  )

Removes all speakers from the world.

void deWorld::RemoveAllTouchSensors (  )

Removes all touch sensors from the world.

void deWorld::RemoveBillboard ( deBillboard billboard )

Removes a billboard.

void deWorld::RemoveCamera ( deCamera camera )

Removes the given camera from the world.

void deWorld::RemoveCollider ( deCollider collider )

Removes the given collider from the world.

void deWorld::RemoveComponent ( deComponent comp )

Removes a component from the world.

void deWorld::RemoveDebugDrawer ( deDebugDrawer debugDrawer )

Removes the given debugDrawer from the world.

void deWorld::RemoveForceField ( deForceField forceField )

Removes the given force fields from the world.

void deWorld::RemoveLight ( deLight light )

Removes the given light from the world.

void deWorld::RemoveLumimeter ( deLumimeter lumimeter )

Removes the given lumimeter from the world.

void deWorld::RemoveMicrophone ( deMicrophone microphone )

Removes the given microphone from the world.

void deWorld::RemoveNetworkState ( deNetworkState networkState )

Removes the given networkState from the world.

void deWorld::RemoveOccluder ( deOccluder occluder )

Removes the given occluder from the world.

void deWorld::RemoveParticleEmitter ( deParticleEmitter emitter )

Removes a particle emitter.

void deWorld::RemovePortalSystem ( dePortalSystem portalSystem )

Removes the given portal system from the world.

void deWorld::RemovePropField ( dePropField propField )

Removes the given prop fields from the world.

void deWorld::RemoveSmokeEmitter ( deSmokeEmitter smokeEmitter )

Removes the given smoke emitters from the world.

void deWorld::RemoveSpeaker ( deSpeaker speaker )

Removes the given speaker from the world.

void deWorld::RemoveTouchSensor ( deTouchSensor touchSensor )

Removes the given touch sensors from the world.

void deWorld::SetAmbientLight ( const decColor color )

Sets the ambient light color.

void deWorld::SetAudioWorld ( deBaseAudioWorld audWorld )

Sets the audio system peer object.

void deWorld::SetDisableLights ( bool  disable )

Sets if all lights are disabled.

void deWorld::SetGraphicWorld ( deBaseGraphicWorld graWorld )

Sets the graphic system peer object.

void deWorld::SetGravity ( const decVector gravity )

Sets the world gravity vector.

void deWorld::SetHeightTerrain ( deHeightTerrain heightTerrain )

Sets the assigned height terrain or NULL to remove it.

void deWorld::SetLightColorMatrix ( const decMatrix matrix )

Sets the light color matrix.

void deWorld::SetNetworkWorld ( deBaseNetworkWorld netWorld )

Sets the audio system peer object.

void deWorld::SetPhysicsWorld ( deBasePhysicsWorld phyWorld )

Sets the physics system peer object.

void deWorld::SetSize ( const decDVector size )

Sets the size of the world.

void deWorld::SetSky ( deSky sky )

Sets the assigned sky or NULL to remove it.

void deWorld::Update ( float  elapsed )

Updates dynamic world parts.

This includes sending a notification to the graphic system peer to update internal data structures. Objects beeing part of the world are not updated with this call. This is to avoid slowing the engine down if a huge amount of objects are in the world.

Parameters:
elapsedSeconds elapsed since the last update

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