The PickupRepresentation class represents a specific pickup type. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/pickup/PickupRepresentation.h>

Inheritance diagram for orxonox::PickupRepresentation:

Public Member Functions
	PickupRepresentation ()
	Constructor. More...

	PickupRepresentation (Context *context)
	Default constructor. More...

virtual	~PickupRepresentation ()
	Destructor. More...

virtual void	changedName () override
	This function gets called if the name of the object changes. More...

StaticEntity *	createSpawnerRepresentation (PickupSpawner *spawner)
	Create a spawnerRepresentation for a specific PickupSpawner. More...

const std::string &	getInventoryRepresentation (void) const
	Get the name of the image representing the pickup in the PickupInventory. More...

const std::string &	getPickupDescription (void) const
	Get the description of the Pickupable represented by this PickupRepresentation. More...

const std::string &	getPickupName (void) const
	Get the name of the Pickupable represented by this PickupRepresentation. More...

const StaticEntity *	getSpawnerRepresentationIndex (unsigned int index) const
	Get the StaticEntity that defines how the PickupSpawner of the Pickupable represented by this PickupRepresentation looks like. More...

const std::string &	getSpawnerTemplate (void) const
	Get the name of spawnerTemplate the Pickupable represented by this PickupRepresentation. More...

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode) override
	Method for creating a PickupRepresentation object through XML. More...

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	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 Member Functions
void	setInventoryRepresentation (const std::string &image)
	Set the image representing the pickup in the PickupInventory. More...

void	setPickupDescription (const std::string &description)
	Set the description of the Pickupable represented by this PickupRepresentation. More...

void	setPickupName (const std::string &name)
	Set the name of the Pickupable represented by this PickupRepresentation. More...

void	setSpawnerRepresentation (StaticEntity *representation)
	Set the StaticEntity that defines how the PickupSpawner of the Pickupable represented by this PickupRepresentation looks like. More...

void	setSpawnerTemplate (const std::string &spawnerTemplate)
	Set the spawnerTemplate of the Pickupable represented by this PickupRepresentation. 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)

Private Member Functions
StaticEntity *	getDefaultSpawnerRepresentation (PickupSpawner *spawner)
	Get the default spawnerRepresentation for a specific PickupSpawner. More...

void	initialize (void)
	Initializes the member variables of this PickupRepresentation. More...

void	registerVariables (void)
	Registers the variables that need to be synchronised. More...

Private Attributes
std::string	description_
	The description of the Pickupable represented by this PickupRepresentation. More...

std::string	inventoryRepresentation_
	The name of an image representing the pickup in the PickupInventory. More...

std::string	name_
	The name of the Pickupable represented by this PickupRepresentation. More...

StaticEntity *	spawnerRepresentation_
	The spawnerRepresentation of this PickupRepresentation. More...

std::string	spawnerTemplate_
	The name of the template of this PickupRepresentation. More...

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 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...

Detailed Description

The PickupRepresentation class represents a specific pickup type.

It defines the information displayed in the GUI (PickupInventory) and how PickupSpawners that spawn the pickup type look like. They are created through XML and are registered with the PickupManager.

Creating a PickupRepresentation in XML could look as follows:

<PickupRepresentation
    name = "My awesome Pickup"
    description = "This is the most awesome Pickup ever to exist."
    spawnerTemplate = "awesomePickupRepresentation"
    inventoryRepresentation = "AwesomePickup"
/>

As you might have noticed, there is a parameter called spawnerTemplate and also another parameter called inventoryRepresentation. Let's first explain the second one, inventoryRepresentation.

The inventoryRepresentation specifies the image that is displayed in the PickupInventory for the specific type of Pickupable. More technically, it is the name of an image located in the PickupInventory.imageset, which in turn is located in data_extern/gui/imagesets/.
The spawnerTemplate specifies how the type of Pickupable (or more precisely the PickupSpawner, that spawns that type of Pickupable) is displayed ingame. It is a Template defined in XML. The spawnerTemplate can be specified as follows (keep in mind, that the template needs to have been specified before the definition of the PickupRepresentation that uses it).
<Template name="awesomePickupRepresentation">
<PickupRepresentation>
<spawner-representation>
<StaticEntity>
<attached>

</attached>
</StaticEntity>
</spawner-representation>
</PickupRepresentation>
</Template>

For the purpose of them working over the network, they are synchronised.

Author: Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::PickupRepresentation::PickupRepresentation ( )

Constructor.

Registers the object and initializes its member variables. This is primarily for use of the PickupManager in creating a default PickupRepresentation.

orxonox::PickupRepresentation::PickupRepresentation ( Context * context )

Default constructor.

Default Constructor.

Registers the object and initializes its member variables.

orxonox::PickupRepresentation::~PickupRepresentation ( )

virtual

Destructor.

Member Function Documentation

void orxonox::PickupRepresentation::changedName ( void )

overridevirtual

This function gets called if the name of the object changes.

Reimplemented from orxonox::BaseObject.

StaticEntity * orxonox::PickupRepresentation::createSpawnerRepresentation ( PickupSpawner * spawner )

Create a spawnerRepresentation for a specific PickupSpawner.

Get a spawnerRepresentation for a specific PickupSpawner.

Parameters

spawner A pointer to the PickupSpawner.

Returns: Returns a pointer to the StaticEntity.

StaticEntity * orxonox::PickupRepresentation::getDefaultSpawnerRepresentation ( PickupSpawner * spawner )

private

Get the default spawnerRepresentation for a specific PickupSpawner.

Helper method of internal use.

Parameters

spawner A pointer to the PickupSpawner.

Returns: Returns a pointer to the StaticEntity.

const std::string& orxonox::PickupRepresentation::getInventoryRepresentation ( void ) const

inline

Get the name of the image representing the pickup in the PickupInventory.

Returns: Returns the name of the image as a string.

const std::string& orxonox::PickupRepresentation::getPickupDescription ( void ) const

inline

Get the description of the Pickupable represented by this PickupRepresentation.

Returns: Returns the description.

const std::string& orxonox::PickupRepresentation::getPickupName ( void ) const

inline

Get the name of the Pickupable represented by this PickupRepresentation.

Returns: Returns the name.

const StaticEntity* orxonox::PickupRepresentation::getSpawnerRepresentationIndex ( unsigned int index ) const

inline

Get the StaticEntity that defines how the PickupSpawner of the Pickupable represented by this PickupRepresentation looks like.

Parameters

index The index.

Returns: Returns (for index = 0) a pointer to the StaticEntity. For index > 0 it returns nullptr.

const std::string& orxonox::PickupRepresentation::getSpawnerTemplate ( void ) const

inline

Get the name of spawnerTemplate the Pickupable represented by this PickupRepresentation.

Returns: Returns the name of the spawnerTemplate.

void orxonox::PickupRepresentation::initialize ( void )

private

Initializes the member variables of this PickupRepresentation.

void orxonox::PickupRepresentation::registerVariables ( void )

private

Registers the variables that need to be synchronised.

Registers the variables that need to be synchornised.

void orxonox::PickupRepresentation::setInventoryRepresentation ( const std::string & image )

inlineprotected

Set the image representing the pickup in the PickupInventory.

Parameters

image A string with the name of the image representing the pickup.

void orxonox::PickupRepresentation::setPickupDescription ( const std::string & description )

inlineprotected

Set the description of the Pickupable represented by this PickupRepresentation.

Parameters

description The Description.

void orxonox::PickupRepresentation::setPickupName ( const std::string & name )

inlineprotected

Set the name of the Pickupable represented by this PickupRepresentation.

Parameters

name The name.

void orxonox::PickupRepresentation::setSpawnerRepresentation ( StaticEntity * representation )

protected

Set the StaticEntity that defines how the PickupSpawner of the Pickupable represented by this PickupRepresentation looks like.

This will be set by the spawnerTemplate. Setting it when creating the PickupRepresentation without creating a template and specifying its name will be futile, because through the course of the game many PickupSpawners for one specific pickup type may have to be created, thus the StaticEntity that is the spawnerRepresentation has to be generated (with the template) for every new PickupSpawner spawning the Pickupable represented by this PickupRepresentation. The spawnerRepresentation that is set here, however can only be used once.

Parameters

representation A pointer to the StaticEntity that is the spawnerRepresentation of this PickupRepresentation.

void orxonox::PickupRepresentation::setSpawnerTemplate ( const std::string & spawnerTemplate )

inlineprotected

Set the spawnerTemplate of the Pickupable represented by this PickupRepresentation.

The spawnerTemplate is a name of a template defined in XML that defines the StaticEntity that is the spawnerRepresentation of this PickupRepresentation.

Parameters

spawnerTemplate The name of the template.

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

overridevirtual

Method for creating a PickupRepresentation object through XML.

Reimplemented from orxonox::BaseObject.

Member Data Documentation

std::string orxonox::PickupRepresentation::description_

private

The description of the Pickupable represented by this PickupRepresentation.

std::string orxonox::PickupRepresentation::inventoryRepresentation_

private

The name of an image representing the pickup in the PickupInventory.

std::string orxonox::PickupRepresentation::name_

private

The name of the Pickupable represented by this PickupRepresentation.

StaticEntity* orxonox::PickupRepresentation::spawnerRepresentation_

private

The spawnerRepresentation of this PickupRepresentation.

std::string orxonox::PickupRepresentation::spawnerTemplate_

private

The name of the template of this PickupRepresentation.

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

modules/pickup/PickupRepresentation.h
modules/pickup/PickupRepresentation.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation