Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
orxonox::WeaponSystem Class Reference

An orxonox::Pawn that is able to fire weapons always need to have a WeaponSystem. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/weaponsystem/WeaponSystem.h>

Inheritance diagram for orxonox::WeaponSystem:
orxonox::BaseObject orxonox::OrxonoxClass orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Identifiable

Public Member Functions

 WeaponSystem (Context *context)
 
virtual ~WeaponSystem ()
 
void addMunition (Munition *munition)
 
bool addWeaponPack (WeaponPack *wPack)
 
bool addWeaponSet (WeaponSet *wSet)
 
bool addWeaponSet (WeaponSet *wSet, unsigned int firemode)
 
void addWeaponSlot (WeaponSlot *wSlot)
 
bool canAddWeaponPack (WeaponPack *wPack)
 
void changeWeaponmode (WeaponPack *wPack, WeaponSet *wSet, unsigned int weaponmode)
 
void fire (unsigned int firemode)
 Fires the orxonox::WeaponSet with the specified firemode. More...
 
const std::vector< WeaponPack * > & getAllWeaponPacks () const
 
const std::vector< WeaponSlot * > & getAllWeaponSlots () const
 
MunitiongetMunition (SubclassIdentifier< Munition > *identifier)
 
PawngetPawn () const
 
WeaponPackgetWeaponPack (unsigned int index) const
 
WeaponSetgetWeaponSet (unsigned int index) const
 
WeaponSlotgetWeaponSlot (unsigned int index) const
 
int getWeaponSlotSize () const
 
void reload ()
 
void removeWeaponPack (WeaponPack *wPack)
 
void removeWeaponSet (WeaponSet *wSet)
 
void removeWeaponSlot (WeaponSlot *wSlot)
 
void setPawn (Pawn *pawn)
 
bool swapWeaponSlots (WeaponSlot *wSlot1, WeaponSlot *wSlot2)
 
- 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...
 
BaseObjectgetCreator () const
 
BaseObjectgetEventListener (unsigned int index) const
 Returns an event listener with a given index. More...
 
BaseObjectgetEventSource (unsigned int index, const std::string &state) const
 Returns an eventsource with a given index. More...
 
const XMLFilegetFile () 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...
 
GametypegetGametype () const
 
LevelgetLevel () 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...
 
NamespacegetNamespace () const
 
const std::string & getOldName () const
 Returns the old name of the object. More...
 
ScenegetScene () const
 
virtual uint32_t getSceneID () const
 
const std::set< Template * > & getTemplates () const
 Returns the set of all aplied templates. More...
 
const mboolisActive () const
 Returns the state of the objects activity. More...
 
bool isInitialized () const
 Returns if the object was initialized (passed the object registration). More...
 
const mboolisVisible () 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...
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving. More...
 
- Public Member Functions inherited from orxonox::OrxonoxClass
 OrxonoxClass ()
 
OrxonoxClassoperator= (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...
 
ContextgetContext () 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 voidgetDerivedPointer (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...
 
IdentifiergetIdentifier () 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...
 

Static Public Member Functions

static unsigned int getFiremodeMask (unsigned int firemode)
 
- 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 Attributes

static const unsigned int FIRE_MODE_UNASSIGNED = static_cast<unsigned int>(-1)
 
static const unsigned int MAX_FIRE_MODES = 8
 
static const unsigned int MAX_WEAPON_MODES = 8
 
static const unsigned int WEAPON_MODE_UNASSIGNED = static_cast<unsigned int>(-1)
 

Private Member Functions

void updateMunition ()
 

Private Attributes

std::map< Identifier *, Munition * > munitions_
 
Pawnpawn_
 
std::vector< WeaponPack * > weaponPacks_
 
std::map< unsigned int, WeaponSet * > weaponSets_
 
std::vector< WeaponSlot * > weaponSlots_
 

Additional Inherited Members

- Protected Member Functions inherited from orxonox::BaseObject
void addEventState (const std::string &name, EventState *container)
 Adds a new event-state to the object. More...
 
EventStategetEventState (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 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

An orxonox::Pawn that is able to fire weapons always need to have a WeaponSystem.

The WeaponSystem manages all the orxonox::WeaponSet, orxonox::WeaponPack and orxonox::WeaponSlot classes.

Constructor & Destructor Documentation

orxonox::WeaponSystem::WeaponSystem ( Context context)
orxonox::WeaponSystem::~WeaponSystem ( )
virtual

Member Function Documentation

void orxonox::WeaponSystem::addMunition ( Munition munition)
bool orxonox::WeaponSystem::addWeaponPack ( WeaponPack wPack)
bool orxonox::WeaponSystem::addWeaponSet ( WeaponSet wSet)
bool orxonox::WeaponSystem::addWeaponSet ( WeaponSet wSet,
unsigned int  firemode 
)
void orxonox::WeaponSystem::addWeaponSlot ( WeaponSlot wSlot)
bool orxonox::WeaponSystem::canAddWeaponPack ( WeaponPack wPack)
void orxonox::WeaponSystem::changeWeaponmode ( WeaponPack wPack,
WeaponSet wSet,
unsigned int  weaponmode 
)
void orxonox::WeaponSystem::fire ( unsigned int  firemode)

Fires the orxonox::WeaponSet with the specified firemode.

const std::vector<WeaponPack *>& orxonox::WeaponSystem::getAllWeaponPacks ( ) const
inline
const std::vector<WeaponSlot *>& orxonox::WeaponSystem::getAllWeaponSlots ( ) const
inline
static unsigned int orxonox::WeaponSystem::getFiremodeMask ( unsigned int  firemode)
inlinestatic
Munition * orxonox::WeaponSystem::getMunition ( SubclassIdentifier< Munition > *  identifier)
Pawn* orxonox::WeaponSystem::getPawn ( ) const
inline
WeaponPack * orxonox::WeaponSystem::getWeaponPack ( unsigned int  index) const
WeaponSet * orxonox::WeaponSystem::getWeaponSet ( unsigned int  index) const
WeaponSlot * orxonox::WeaponSystem::getWeaponSlot ( unsigned int  index) const
int orxonox::WeaponSystem::getWeaponSlotSize ( ) const
inline
void orxonox::WeaponSystem::reload ( )
void orxonox::WeaponSystem::removeWeaponPack ( WeaponPack wPack)
void orxonox::WeaponSystem::removeWeaponSet ( WeaponSet wSet)
void orxonox::WeaponSystem::removeWeaponSlot ( WeaponSlot wSlot)
void orxonox::WeaponSystem::setPawn ( Pawn pawn)
inline
bool orxonox::WeaponSystem::swapWeaponSlots ( WeaponSlot wSlot1,
WeaponSlot wSlot2 
)
void orxonox::WeaponSystem::updateMunition ( )
private

Member Data Documentation

const unsigned int orxonox::WeaponSystem::FIRE_MODE_UNASSIGNED = static_cast<unsigned int>(-1)
static
const unsigned int orxonox::WeaponSystem::MAX_FIRE_MODES = 8
static
const unsigned int orxonox::WeaponSystem::MAX_WEAPON_MODES = 8
static
std::map<Identifier *, Munition *> orxonox::WeaponSystem::munitions_
private
Pawn* orxonox::WeaponSystem::pawn_
private
const unsigned int orxonox::WeaponSystem::WEAPON_MODE_UNASSIGNED = static_cast<unsigned int>(-1)
static
std::vector<WeaponPack *> orxonox::WeaponSystem::weaponPacks_
private
std::map<unsigned int, WeaponSet *> orxonox::WeaponSystem::weaponSets_
private
std::vector<WeaponSlot *> orxonox::WeaponSystem::weaponSlots_
private

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