orxonox::SpaceShip Class Reference

#include <src/orxonox/objects/worldentities/pawns/SpaceShip.h>

Inheritance diagram for orxonox::SpaceShip:

orxonox::Pawn orxonox::ControllableEntity orxonox::RadarViewable orxonox::MobileEntity orxonox::OrxonoxClass orxonox::WorldEntity orxonox::Tickable orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxClass orxonox::OrxonoxClass orxonox::Destroyer

List of all members.

Public Member Functions

virtual void boost ()
virtual void fire ()
bool getBoost () const
EnginegetEngine () const
const std::stringgetEngineTemplate () const
bool getPermanentBoost () const
const Vector3 & getSteeringDirection () const
virtual void moveFrontBack (const Vector2 &value)
virtual void moveRightLeft (const Vector2 &value)
virtual void moveUpDown (const Vector2 &value)
void registerVariables ()
virtual void rotatePitch (const Vector2 &value)
virtual void rotateRoll (const Vector2 &value)
virtual void rotateYaw (const Vector2 &value)
void setBoost (bool bBoost)
void setConfigValues ()
 Function to collect the SetConfigValue-macro calls.
void setEngine (Engine *engine)
void setEngineTemplate (const std::string &temp)
void setPermanentBoost (bool bPermanent)
void setSteeringDirection (const Vector3 &direction)
 SpaceShip (BaseObject *creator)
virtual void tick (float dt)
 Gets called every frame.
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving.
virtual ~SpaceShip ()

Protected Attributes

float auxilaryThrust_
bool bBoost_
bool bInvertYAxis_
bool bPermanentBoost_
btVector3 localAngularAcceleration_
btVector3 localLinearAcceleration_
float primaryThrust_
float rotationThrust_
Vector3 steering_

Private Member Functions

virtual bool isCollisionTypeLegal (WorldEntity::CollisionType type) const
 Function checks whether the requested collision type is legal to this object.
void loadEngineTemplate ()

Private Attributes

Engineengine_
std::string enginetemplate_


Constructor & Destructor Documentation

orxonox::SpaceShip::SpaceShip ( BaseObject creator  ) 

orxonox::SpaceShip::~SpaceShip (  )  [virtual]


Member Function Documentation

void orxonox::SpaceShip::boost (  )  [virtual]

Reimplemented from orxonox::ControllableEntity.

References bBoost_.

void orxonox::SpaceShip::fire (  )  [virtual]

bool orxonox::SpaceShip::getBoost (  )  const [inline]

Engine* orxonox::SpaceShip::getEngine (  )  const [inline]

const std::string& orxonox::SpaceShip::getEngineTemplate (  )  const [inline]

Referenced by XMLPort().

bool orxonox::SpaceShip::getPermanentBoost (  )  const [inline]

Referenced by orxonox::Engine::tick().

const Vector3& orxonox::SpaceShip::getSteeringDirection (  )  const [inline]

bool orxonox::SpaceShip::isCollisionTypeLegal ( WorldEntity::CollisionType  type  )  const [private, virtual]

Function checks whether the requested collision type is legal to this object.

You can override this function in a derived class to constrain the collision to e.g. None or Dynamic. A projectile may not prove very useful if there is no physical body. Simply set the CollisionType in its constructor and override this method. But be careful that a derived classe's virtual functions don't yet exist in the constructor if a base class.

Reimplemented from orxonox::MobileEntity.

References CCOUT, and orxonox::WorldEntity::Dynamic.

void orxonox::SpaceShip::loadEngineTemplate (  )  [private]

void orxonox::SpaceShip::moveFrontBack ( const Vector2 &  value  )  [virtual]

Reimplemented from orxonox::ControllableEntity.

References localLinearAcceleration_, and steering_.

void orxonox::SpaceShip::moveRightLeft ( const Vector2 &  value  )  [virtual]

Reimplemented from orxonox::ControllableEntity.

References localLinearAcceleration_, and steering_.

void orxonox::SpaceShip::moveUpDown ( const Vector2 &  value  )  [virtual]

Reimplemented from orxonox::ControllableEntity.

References localLinearAcceleration_, and steering_.

void orxonox::SpaceShip::registerVariables (  ) 

void orxonox::SpaceShip::rotatePitch ( const Vector2 &  value  )  [virtual]

void orxonox::SpaceShip::rotateRoll ( const Vector2 &  value  )  [virtual]

void orxonox::SpaceShip::rotateYaw ( const Vector2 &  value  )  [virtual]

void orxonox::SpaceShip::setBoost ( bool  bBoost  )  [inline]

Referenced by orxonox::Engine::tick().

void orxonox::SpaceShip::setConfigValues (  ) 

Function to collect the SetConfigValue-macro calls.

Reimplemented from orxonox::ControllableEntity.

References bInvertYAxis_, and SetConfigValue.

Referenced by SpaceShip().

void orxonox::SpaceShip::setEngine ( Engine engine  ) 

void orxonox::SpaceShip::setEngineTemplate ( const std::string temp  )  [inline]

Referenced by XMLPort().

void orxonox::SpaceShip::setPermanentBoost ( bool  bPermanent  )  [inline]

void orxonox::SpaceShip::setSteeringDirection ( const Vector3 &  direction  )  [inline]

Referenced by orxonox::Engine::tick().

void orxonox::SpaceShip::tick ( float  dt  )  [virtual]

void orxonox::SpaceShip::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
) [virtual]

XML loading and saving.

Parameters:
xmlelement The XML-element
loading Loading (true) or saving (false)
Returns:
The XML-element

Reimplemented from orxonox::Pawn.

References auxilaryThrust_, getEngineTemplate(), primaryThrust_, rotationThrust_, setEngineTemplate(), SUPER, XMLPortParam, and XMLPortParamVariable.


Member Data Documentation

bool orxonox::SpaceShip::bBoost_ [protected]

Referenced by boost(), and SpaceShip().

Referenced by setConfigValues(), and SpaceShip().

Referenced by SpaceShip().

Referenced by loadEngineTemplate().

Vector3 orxonox::SpaceShip::steering_ [protected]


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

Generated on Tue Jul 28 16:23:04 2009 for Orxonox by  doxygen 1.5.6