orxonox::ShipPart Class Reference

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/items/ShipPart.h>

Inheritance diagram for orxonox::ShipPart:

Public Member Functions
	ShipPart (Context *context)
virtual	~ShipPart ()
void	addDestructionEvent (PartDestructionEvent *event)
	Add a PartDestructionEvent to the ShipPart. More...
void	addEntity (StaticEntity *entity)
	Add a StaticEntity to the ShipPart. More...
void	addHealth (float health)
virtual void	death ()
	Is called when the ShipPart dies. More...
virtual void	explode ()
float	getDamageAbsorption () const
PartDestructionEvent *	getDestructionEvent (unsigned int index)
	Get the i-th PartDestructionEvent of the ShipPart. More...
StaticEntity *	getEntity (unsigned int index)
	Get the i-th StaticEntity of the ShipPart. More...
Vector3	getExplosionPosition ()
float	getHealth () const
float	getInitialHealth () const
float	getMaxHealth () const
ModularSpaceShip *	getParent () const
virtual void	handleHit (float damage, float healthdamage, float shielddamage, Pawn *originator)
	Handles a received hit. More...
bool	hasEntity (StaticEntity *entity) const
	Check whether the ShipPart has a particular Entity. More...
bool	isEventExecution () const
void	removeHealth (float health)
void	setDamageAbsorption (float value)
void	setEventExecution (bool var)
void	setExplosionPosition (Vector3 pos)
void	setHealth (float health)
void	setInitialHealth (float initialhealth)
void	setMaxHealth (float maxhealth)
void	setParent (ModularSpaceShip *ship)
virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode) override
	XML loading and saving. More...
Public Member Functions inherited from orxonox::Item
	Item (Context *context)
virtual	~Item ()
Public Member Functions inherited from orxonox::BaseObject
	BaseObject (Context *context)
	Constructor: Registers the object in the BaseObject-list. More...
virtual	~BaseObject ()
	Destructor. More...
void	addEventListener (BaseObject *listener)
	Adds an object which listens to the events of this object. More...
void	addEventSource (BaseObject *source, const std::string &state)
	Adds a new event source for a specific state. More...
void	addTemplate (const std::string &name)
	Adds a Template to the object. More...
void	addTemplate (Template *temp)
	Adds a Template to the object. More...
virtual void	changedActivity ()
	This function gets called if the activity of the object changes. More...
virtual void	changedMainStateName ()
	This function gets called if the main state name of the object changes. More...
virtual void	changedName ()
	This function gets called if the name of the object changes. More...
virtual void	changedVisibility ()
	This function gets called if the visibility of the object changes. More...
void	fireEvent (const std::string &name="")
	Fires an event (without a state). More...
void	fireEvent (bool activate, const std::string &name="")
	Fires an event which activates or deactivates a state. More...
void	fireEvent (bool activate, BaseObject *originator, const std::string &name="")
	Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...
void	fireEvent (Event &event)
	Fires an event, using the Event struct. More...
BaseObject *	getCreator () const
BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...
BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...
const XMLFile *	getFile () const
	Returns a pointer to the XMLFile that loaded this object. More...
const std::string &	getFilename () const
	Returns the levelfile that loaded this object. More...
Gametype *	getGametype () const
Level *	getLevel () const
const std::string &	getLoaderIndentation () const
	Returns the indentation of the debug output in the Loader. More...
const std::string &	getMainStateName () const
	Returns the name of the main state. More...
const std::string &	getName () const
	Returns the name of the object. More...
Namespace *	getNamespace () const
const std::string &	getOldName () const
	Returns the old name of the object. More...
Scene *	getScene () const
virtual uint32_t	getSceneID () const
const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...
const mbool &	isActive () const
	Returns the state of the objects activity. More...
bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...
const mbool &	isVisible () const
	Returns the state of the objects visibility. More...
virtual void	processEvent (Event &event)
	Processing an event by calling the right main state. More...
void	removeEventSource (BaseObject *source)
	Removes an eventsource (but doesn't unregister itself at the source). More...
void	setActive (bool bActive)
	Sets the state of the objects activity. More...
void	setCreator (BaseObject *creator)
void	setFile (const XMLFile *file)
	Sets a pointer to the xml file that loaded this object. More...
void	setGametype (const StrongOrWeakPtr< Gametype > &gametype)
void	setLevel (const StrongOrWeakPtr< Level > &level)
void	setLoaderIndentation (const std::string &indentation)
	Sets the indentation of the debug output in the Loader. More...
void	setMainState (bool state)
	Sets the main state of the object to a given boolean value. More...
void	setMainStateName (const std::string &name)
	Sets the name of the main state (used for event reactions). More...
void	setName (const std::string &name)
	Sets the name of the object. More...
void	setNamespace (const StrongOrWeakPtr< Namespace > &ns)
void	setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)
void	setVisible (bool bVisible)
	Sets the state of the objects visibility. More...
virtual void	XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
	Defines the possible event states of this object and parses eventsources from an XML file. More...
Public Member Functions inherited from orxonox::OrxonoxClass
	OrxonoxClass ()
OrxonoxClass &	operator= (const OrxonoxClass &)=default
Public Member Functions inherited from orxonox::Configurable
	Configurable ()
void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...
Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...
	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...
virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...
Context *	getContext () const
void	setContext (Context *context)
	Changes the context. More...
void	unregisterObject ()
	Removes this object from the object-lists. More...
Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...
virtual	~Identifiable ()
ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...
template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...
Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...
bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...
template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...
bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...
bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...
template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...
template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...
bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...
bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...
template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...
bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...
Public Member Functions inherited from orxonox::Destroyable
	Destroyable ()
	Constructor: Sets the default values. More...
virtual	~Destroyable ()
	Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...
void	destroy ()
	Deletes the object if no strong pointers point to this object. More...
void	destroyLater ()
	Works like destroy() but doesn't destroy the object until the current tick has ended. More...
unsigned int	getReferenceCount () const
	Returns the number of strong pointers that point to this object. More...
Public Member Functions inherited from orxonox::Synchronisable
virtual	~Synchronisable ()
	Destructor: Delete all callback objects and remove objectID_ from the objectMap_. More...
uint32_t	getClassID () const
unsigned int	getContextID () const
uint32_t	getNrOfVariables ()
uint32_t	getObjectID () const
unsigned int	getPriority () const
uint8_t	getSyncMode () const
uint32_t	getVarSize (VariableID ID)
template<>
_NetworkExport void	registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
template<>
void	registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)
void	setSyncMode (uint8_t mode)
	This function sets the synchronisation mode of the object If set to 0x0 variables will not be synchronised at all If set to 0x1 variables will only be synchronised to the client If set to 0x2 variables will only be synchronised to the server If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) More...
template<>
_NetworkExport void	unregisterVariable (std::string &variable)
template<>
void	unregisterVariable (std::string &variable)
Public Member Functions inherited from orxonox::OrxonoxInterface
	OrxonoxInterface ()

Protected Attributes
float	damageAbsorption_
float	health_
float	initialHealth_
float	maxHealth_
ModularSpaceShip *	parent_
unsigned int	parentID_
Protected Attributes inherited from orxonox::BaseObject
mbool	bActive_
	True = the object is active. More...
mbool	bVisible_
	True = the object is visible. More...
FunctorPtr	mainStateFunctor_
std::string	mainStateName_
std::string	name_
	The name of the object. More...
std::set< std::string >	networkTemplateNames_
std::string	oldName_
	The old name of the object. More...

Private Attributes
std::vector< StaticEntity * >	entityList_
bool	eventExecution_
std::vector< PartDestructionEvent * >	eventList_
Vector3	explosionPosition_
float	healthMem_

Additional Inherited Members
Static Public Member Functions inherited from orxonox::BaseObject
static void	loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject *object, Identifier *identifier)
	Manually loads all event states, even if the class doesn't officially support them. More...
Static Public Member Functions inherited from orxonox::Synchronisable
static bool	deleteObject (uint32_t objectID_)
	Finds and deletes the Synchronisable with the appropriate objectID_. More...
static Synchronisable *	fabricate (uint8_t *&mem, uint8_t mode=0x0)
	This function fabricated a new synchrnisable (and children of it), sets calls updateData and create After calling this function the mem pointer will be increased by the size of the needed data. More...
static unsigned int	getNumberOfDeletedObject ()
static Synchronisable *	getSynchronisable (uint32_t objectID_)
	This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable. More...
static uint32_t	popDeletedObject ()
static void	setClient (bool b)
	This function sets the internal mode for synchronisation. More...
Protected Member Functions inherited from orxonox::BaseObject
void	addEventState (const std::string &name, EventState *container)
	Adds a new event-state to the object. More...
EventState *	getEventState (const std::string &name) const
	Returns the event-state with the given name. More...
Protected Member Functions inherited from orxonox::Destroyable
virtual void	preDestroy ()
	This virtual function is called if destroy() is called and no StrongPtr points to this object. More...
Protected Member Functions inherited from orxonox::Synchronisable
	Synchronisable (Context *context)
	Constructor: Initializes all Variables and sets the right objectID_. More...
uint32_t	findContextID (Context *context)
	Returns the id of the context. More...
template<class T >
void	registerVariable (T &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
template<class T >
void	registerVariable (std::set< T > &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)
void	setPriority (unsigned int freq)
template<class T >
void	unregisterVariable (T &var)

Constructor & Destructor Documentation

orxonox::ShipPart::ShipPart

(

Context *

context

)

orxonox::ShipPart::~ShipPart ( )

virtual

Member Function Documentation

void orxonox::ShipPart::addDestructionEvent

(

PartDestructionEvent *

event

)

Add a PartDestructionEvent to the ShipPart.

Parameters

event

A pointer to the PartDestructionEvent to be added.

void orxonox::ShipPart::addEntity

(

StaticEntity *

entity

)

Add a StaticEntity to the ShipPart.

Parameters

entity

A pointer to the StaticEntity to be added.

void orxonox::ShipPart::addHealth ( float  health )

inline

void orxonox::ShipPart::death ( )

virtual

Is called when the ShipPart dies.

Executes PartDestructionEvents. Tells the ModularSpaceShip to remove this ShipPart.

void orxonox::ShipPart::explode ( )

virtual

float orxonox::ShipPart::getDamageAbsorption ( ) const

inline

PartDestructionEvent * orxonox::ShipPart::getDestructionEvent

(

unsigned int

index

)

Get the i-th PartDestructionEvent of the ShipPart.

Returns

Returns a pointer to the i-the PartDestructionEvent. nullptr if there is no PartDestructionEvent with that index.

StaticEntity * orxonox::ShipPart::getEntity

(

unsigned int

index

)

Get the i-th StaticEntity of the ShipPart.

Returns

Returns a pointer to the i-the StaticEntity. nullptr if there is no StaticEntity with that index.

Vector3 orxonox::ShipPart::getExplosionPosition ( )

inline

float orxonox::ShipPart::getHealth ( ) const

inline

float orxonox::ShipPart::getInitialHealth ( ) const

inline

float orxonox::ShipPart::getMaxHealth ( ) const

inline

ModularSpaceShip* orxonox::ShipPart::getParent ( ) const

inline

void orxonox::ShipPart::handleHit ( float  damage, float  healthdamage, float  shielddamage, Pawn *  originator  )

virtual

Handles a received hit.

bool orxonox::ShipPart::hasEntity

(

StaticEntity *

search

)

const

Check whether the ShipPart has a particular Entity.

Parameters

search

A pointer to the Entity to be checked.

bool orxonox::ShipPart::isEventExecution ( ) const

inline

void orxonox::ShipPart::removeHealth ( float  health )

inline

void orxonox::ShipPart::setDamageAbsorption ( float  value )

inline

void orxonox::ShipPart::setEventExecution ( bool  var )

inline

void orxonox::ShipPart::setExplosionPosition ( Vector3  pos )

inline

void orxonox::ShipPart::setHealth ( float  health )

inline

void orxonox::ShipPart::setInitialHealth ( float  initialhealth )

inline

void orxonox::ShipPart::setMaxHealth ( float  maxhealth )

inline

void orxonox::ShipPart::setParent

(

ModularSpaceShip *

ship

)

void orxonox::ShipPart::XMLPort ( Element &  xmlelement, XMLPort::Mode  mode  )

overridevirtual

XML loading and saving.

Parameters

xmlelement	The XML-element
mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented from orxonox::BaseObject.

Member Data Documentation

float orxonox::ShipPart::damageAbsorption_

protected

std::vector<StaticEntity*> orxonox::ShipPart::entityList_

private

bool orxonox::ShipPart::eventExecution_

private

std::vector<PartDestructionEvent*> orxonox::ShipPart::eventList_

private

Vector3 orxonox::ShipPart::explosionPosition_

private

float orxonox::ShipPart::health_

protected

float orxonox::ShipPart::healthMem_

private

float orxonox::ShipPart::initialHealth_

protected

float orxonox::ShipPart::maxHealth_

protected

ModularSpaceShip* orxonox::ShipPart::parent_

protected

unsigned int orxonox::ShipPart::parentID_

protected

---

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

• orxonox/items/ShipPart.h
• orxonox/items/ShipPart.cc