Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
orxonox::WagnisGun Class Reference

Shoots laser beams. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/weapons/weaponmodes/WagnisGun.h>

Inheritance diagram for orxonox::WagnisGun:
orxonox::WeaponMode orxonox::BaseObject orxonox::OrxonoxClass orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Identifiable

Public Member Functions

 WagnisGun (Context *context)
 
virtual ~WagnisGun ()
 
virtual void fire () override
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode) override
 XML loading and saving. More...
 
- Public Member Functions inherited from orxonox::WeaponMode
 WeaponMode (Context *context)
 
virtual ~WeaponMode ()
 
void computeMuzzleParameters (const Vector3 &target)
 
virtual bool fire (float *reloadTime)
 
bool getAutoReload () const
 
float getDamage () const
 
float getHealthDamage () const
 
const std::string & getHUDImageString () const
 
unsigned int getInitialMagazines () const
 
unsigned int getInitialMunition () const
 
unsigned int getMode () const
 
MunitiongetMunition () const
 
const std::string & getMunitionName () const
 
unsigned int getMunitionPerShot () const
 
IdentifiergetMunitionType () const
 
Vector3 getMuzzleDirection () const
 
const Vector3 & getMuzzleOffset () const
 
const Quaternion & getMuzzleOrientation () const
 
const Vector3 & getMuzzlePosition () const
 
bool getParallelReload () const
 
bool getReloading () const
 
float getReloadTime () const
 
float getShieldDamage () const
 
Vector3 getTarget ()
 
WeapongetWeapon () const
 
bool reload ()
 
void setAutoReload (bool autoreload)
 
void setDamage (float damage)
 
void setHealthDamage (float healthdamage)
 
void setInitialMagazines (unsigned int amount)
 
void setInitialMunition (unsigned int amount)
 
void setMode (unsigned int mode)
 
void setMunitionName (const std::string &munitionname)
 
void setMunitionPerShot (unsigned int amount)
 
void setMunitionType (Identifier *identifier)
 
void setMuzzleOffset (const Vector3 &offset)
 
void setParallelReload (bool parallelreload)
 
void setReloadTime (float time)
 
void setShieldDamage (float shielddamage)
 
void setWeapon (Weapon *weapon)
 
void updateMunition ()
 
- 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...
 
- 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...
 

Protected Member Functions

float getDelay () const
 Get the firing delay. More...
 
const std::string & getMaterial () const
 Get the material. More...
 
const std::string & getMesh () const
 Get the mesh. More...
 
const std::string & getSound () const
 Get the sound. More...
 
void muzzleflash ()
 
void setDelay (float delay)
 Set the firing delay. More...
 
void setMaterial (const std::string &material)
 Set the material. More...
 
void setMesh (const std::string &mesh)
 Set the mesh. More...
 
void setSound (const std::string &sound)
 Set the sound. More...
 
virtual void shot ()
 Fires the weapon. More...
 
- Protected Member Functions inherited from orxonox::WeaponMode
const std::string & getFireSound ()
 
const std::string & getReloadSound ()
 
void playFireSound ()
 
void playReloadSound ()
 
void setFireSound (const std::string &soundPath, const float soundVolume=1.0)
 
void setReloadSound (const std::string &soundPath, const float soundVolume=1.0)
 
- 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

float delay_
 The firing delay. More...
 
Timer delayTimer_
 A timer to delay the firing. More...
 
std::string material_
 The material. More...
 
std::string mesh_
 The mesh. More...
 
std::string sound_
 The sound. More...
 
float speed_
 The speed of the fired projectile. More...
 
- Protected Attributes inherited from orxonox::WeaponMode
bool bAutoReload_
 
bool bParallelReload_
 
float damage_
 
float healthdamage_
 
std::string hudImageString_
 
unsigned int initialMagazines_
 
unsigned int initialMunition_
 
unsigned int munitionPerShot_
 
Vector3 muzzleOffset_
 
float reloadTime_
 
float shielddamage_
 
- 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...
 

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

Detailed Description

Shoots laser beams.

Author
Hagen Seifert

Constructor & Destructor Documentation

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

Member Function Documentation

void orxonox::WagnisGun::fire ( )
overridevirtual

Implements orxonox::WeaponMode.

float orxonox::WagnisGun::getDelay ( ) const
inlineprotected

Get the firing delay.

Returns
Returns the firing delay in seconds.
const std::string& orxonox::WagnisGun::getMaterial ( ) const
inlineprotected

Get the material.

Returns
Returns the material name.
const std::string& orxonox::WagnisGun::getMesh ( ) const
inlineprotected

Get the mesh.

Returns
Returns the mesh name.
const std::string& orxonox::WagnisGun::getSound ( ) const
inlineprotected

Get the sound.

Returns
Returns the sound name.
void orxonox::WagnisGun::muzzleflash ( )
protected
void orxonox::WagnisGun::setDelay ( float  delay)
protected

Set the firing delay.

Parameters
delayThe firing delay in seconds.
void orxonox::WagnisGun::setMaterial ( const std::string &  material)
inlineprotected

Set the material.

Parameters
materialThe material name.
void orxonox::WagnisGun::setMesh ( const std::string &  mesh)
inlineprotected

Set the mesh.

Parameters
meshThe mesh name.
void orxonox::WagnisGun::setSound ( const std::string &  sound)
inlineprotected

Set the sound.

Parameters
soundThe Sound name.
void orxonox::WagnisGun::shot ( )
protectedvirtual

Fires the weapon.

Creates a projectile and fires it.

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

XML loading and saving.

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

Reimplemented from orxonox::WeaponMode.

Member Data Documentation

float orxonox::WagnisGun::delay_
protected

The firing delay.

Timer orxonox::WagnisGun::delayTimer_
protected

A timer to delay the firing.

std::string orxonox::WagnisGun::material_
protected

The material.

std::string orxonox::WagnisGun::mesh_
protected

The mesh.

std::string orxonox::WagnisGun::sound_
protected

The sound.

float orxonox::WagnisGun::speed_
protected

The speed of the fired projectile.


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