MSDE Class Reference

#include <MSDE.h>

Inheritance diagram for MSDE:

List of all members.

---

Detailed Description

Main Interface class for the Mission Simulation Dynamic Engine

Public Member Functions
virtual	~MSDE ()
	MSDE ()
virtual MSDE_Rover *	addRover ()
virtual MSDE_Rover *	addRover (msf::STRING name)
virtual MSDE_Rover *	addRover (msf::STRING name, msf::Vector6f pose)
virtual MSDE_Terrain *	createTerrain ()
virtual MSDE_Terrain *	getTerrain ()
void	addClient (MSDE_Client *newClient)
virtual void	reset ()
virtual void	quit ()
virtual void	setGravity (Vector3f v)
MSDE_Rover *	getRover (msf::STRING Name)
virtual void	step ()
virtual void	step (float timestep)
Protected Member Functions
void	setupRoverClient (MSDE_Rover *rover)
void	setupTerrainClient (MSDE_Terrain *terrain)
Protected Attributes
map< msf::STRING, MSDE_Rover * >	roverMap
slist< MSDE_Client * >	clientList
MSDE_Terrain *	terrain

---

Constructor & Destructor Documentation

virtual MSDE::~MSDE (   )  [inline, virtual]

MSDE::MSDE (   )  [inline]

---

Member Function Documentation

virtual MSDE_Rover* MSDE::addRover (   )  [inline, virtual]

Function Adds a new Rover to the Engine with Default Name and Position Implemented in Physics specific sub class, I.E MSDE_ODE Reimplemented in MSDE_ODE.

virtual MSDE_Rover* MSDE::addRover (  msf::STRING  name  )  [inline, virtual]

Function Adds a new Rover to the Engine with Default Position Implemented in Physics specific sub class, I.E MSDE_ODE Parameters: name:  name of Rover Reimplemented in MSDE_ODE.

virtual MSDE_Rover* MSDE::addRover (  msf::STRING  name, msf::Vector6f  pose )  [inline, virtual]

Function Adds a new Rover to the Engine Implemented in Physics specific sub class, I.E MSDE_ODE Parameters: name:  name of Rover pose:  Initial Position and Pose of the Rover Reimplemented in MSDE_ODE.

virtual MSDE_Terrain* MSDE::createTerrain (   )  [inline, virtual]

Creates and Returns a new MSDE_Terrain object Reimplemented in MSDE_ODE.

virtual MSDE_Terrain* MSDE::getTerrain (   )  [inline, virtual]

Returns the current MSDE_Terrain object Reimplemented in MSDE_ODE.

void MSDE::addClient (  MSDE_Client *  newClient  )

Attaches a MSDE_Client to the MSDE instance to provide a variety of plugin like capabilities to the MSDE Parameters: newClient:  Pointer to a instance of the MSDE_Client to attach to the Engine

void MSDE::reset (   )  [virtual]

Reset the Simulation to its starting state

void MSDE::quit (   )  [virtual]

Tells MSDE to clean up and properly exit the simulation *

virtual void MSDE::setGravity (  Vector3f  v  )  [inline, virtual]

Accepts an Acceleration Vector indicating the direction/intensity of gravity in the Sim Parameters: v:  Vector specifying the acceleration due to gravity to be applied to objects each timestep Reimplemented in MSDE_ODE.

MSDE_Rover * MSDE::getRover (  msf::STRING  Name  )

Returns the MSDE_Rover of name Name Parameters: Name:  name of rover to return

virtual void MSDE::step (   )  [inline, virtual]

Default step function timestep =10 Reimplemented in MSDE_ODE.

void MSDE::step (  float  timestep  )  [virtual]

Function to advance simulation by Timestep seconds Sets causes collisions and constraints to be resolved and a host of other actions Parameters: timestep:  time in seconds to advance Reimplemented in MSDE_ODE.

void MSDE::setupRoverClient (  MSDE_Rover *  rover  )  [protected]

Helps to Attach each Client module to the Rover Objects Use internally Parameters: rover:  rover to add client too

void MSDE::setupTerrainClient (  MSDE_Terrain *  terrain  )  [protected]

Helps Attach Each Client Module to the Terrain Object Used Internally Only Parameters: terrain:  Terrain to add client too

---

Member Data Documentation

map<msf::STRING,MSDE_Rover* > MSDE::roverMap [protected]

Data Structure to keep a name indexed list of MSDE_Rover objects

slist<MSDE_Client*> MSDE::clientList [protected]

Data Structure to keep a list of Client attached to the MSDE

MSDE_Terrain* MSDE::terrain [protected]

Pointer to the Terrain Object used by this particular instance of the MSDE

---

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

• MSDE.h
• MSDE.cpp

---