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

Creates a turret with limited rotation. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/objects/Turret.h>

Inheritance diagram for orxonox::Turret:
orxonox::Pawn orxonox::ControllableEntity orxonox::RadarViewable orxonox::PickupCarrier orxonox::MobileEntity orxonox::OrxonoxInterface orxonox::OrxonoxInterface orxonox::WorldEntity orxonox::Tickable orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxInterface orxonox::Listable orxonox::Listable orxonox::OrxonoxClass orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Identifiable orxonox::Identifiable orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Listable orxonox::Listable orxonox::Identifiable orxonox::Identifiable orxonox::Identifiable orxonox::TowerDefenseTower

Public Member Functions

 Turret (Context *context)
 Sets default values for all variables. More...
 
virtual ~Turret ()
 Destructor. More...
 
virtual void aimAtPosition (const Vector3 &position)
 Rotates the turret to make it aim at a certain position. More...
 
float getMaxAttackRadius () const
 Returns the maximum distance the turret is allowed to shoot. More...
 
float getMaxPitch () const
 Returns the maximum pitch the turret can have. More...
 
float getMaxYaw () const
 Returns the maximum yaw the turret can have. More...
 
float getMinAttackRadius () const
 Returns the minimum distance the turret is allowed to shoot. More...
 
float getRotationThrust ()
 
virtual float isInRange (const WorldEntity *target)
 Checks, if a WorldEntity is inside the turret's range. More...
 
virtual void rotatePitch (const Vector2 &value) override
 Does currently nothing. More...
 
virtual void rotateRoll (const Vector2 &value) override
 Does currently nothing. More...
 
virtual void rotateYaw (const Vector2 &value) override
 Does currently nothing. More...
 
void setMaxAttackRadius (float radius)
 Sets the maximum distance the turret is allowed to shoot. More...
 
void setMaxPitch (float pitch)
 Sets the maximum pitch the turret can have (in both directions). More...
 
void setMaxYaw (float yaw)
 Sets the maximum yaw the turret can have (in both directions). More...
 
void setMinAttackRadius (float radius)
 Sets the minimum distance the turret is allowed to shoot. More...
 
void setRotationThrust (float rotationthrust)
 
virtual void tick (float dt) override
 The turret's actions are done here. More...
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode) override
 Loads parameters from xml. More...
 
- Public Member Functions inherited from orxonox::Pawn
 Pawn (Context *context)
 
virtual ~Pawn ()
 
virtual void addedWeaponPack (WeaponPack *wPack)
 
void addExplosionPart (ExplosionPart *ePart)
 
void addHealth (float health)
 
void addMunitionXML (Munition *munition)
 
void addShieldHealth (float amount)
 
void addWeaponPack (WeaponPack *wPack)
 
void addWeaponPackXML (WeaponPack *wPack)
 
void addWeaponSet (WeaponSet *wSet)
 
void addWeaponSlot (WeaponSlot *wSlot)
 
virtual void changedVisibility () override
 When the visibility is changed, it is changed for all attached objects as well. More...
 
virtual void changedVulnerability ()
 This function gets called if the vulnerability of the pawn changes. More...
 
void decreaseShieldRechargeCountdownTime (float dt)
 
bool doesAcceptPickups ()
 
virtual void fired (unsigned int firemode) override
 Check whether the Pawn has a orxonox::WeaponSystem and fire it with the specified firemode if it has one. More...
 
Vector3 getAimPosition ()
 
virtual const Vector3 & getCarrierPosition (void) const override
 Get the (absolute) position of the PickupCarrier. More...
 
float getDamageMultiplier () const
 
unsigned int getExplosionChunks () const
 
ExplosionPartgetExplosionPart ()
 
const std::string & getExplosionSound ()
 
float getHealth () const
 
float getInitialHealth () const
 
float getInitialShieldHealth () const
 
ControllableEntitygetLastHitOriginator () const
 
float getMaxHealth () const
 
float getMaxShieldHealth () const
 
MunitiongetMunition (SubclassIdentifier< Munition > *identifier)
 
MunitiongetMunitionXML () const
 
float getShieldAbsorption ()
 
float getShieldHealth ()
 
float getShieldRechargeRate () const
 
float getShieldRechargeWaitTime () const
 
float getSpawnParticleDuration () const
 
const std::string & getSpawnParticleSource () const
 
WeaponPackgetWeaponPack (unsigned int index) const
 
WeaponSetgetWeaponSet (unsigned int index) const
 
WeaponSlotgetWeaponSlot (unsigned int index) const
 
const WeaponSystemgetWeaponSystem () const
 
bool hasShield ()
 
virtual void hit (Pawn *originator, const Vector3 &force, const btCollisionShape *cs, float damage, float healthdamage=0.0f, float shielddamage=0.0f)
 
virtual void hit (Pawn *originator, btManifoldPoint &contactpoint, const btCollisionShape *cs, float damage, float healthdamage=0.0f, float shielddamage=0.0f)
 
bool isAlive () const
 
const bool & isVulnerable () const
 Returns the state of the pawns vulnerability. More...
 
virtual void kill ()
 
virtual void postSpawn ()
 
void removeHealth (float health)
 
void resetShieldRechargeCountdown ()
 
void restoreInitialShieldHealth ()
 
void restoreMaxShieldHealth ()
 
void setAimPosition (Vector3 position)
 
void setDamageMultiplier (float multiplier)
 
void setExplosionChunks (unsigned int chunks)
 
void setExplosionSound (const std::string &engineSound)
 
void setHealth (float health)
 
void setInitialHealth (float initialhealth)
 
void setInitialShieldHealth (float initialshieldhealth)
 
void setMaxHealth (float maxhealth)
 
void setMaxShieldHealth (float maxshieldhealth)
 
void setPickupAcceptance (bool b)
 
void setShieldAbsorption (float shieldAbsorption)
 
void setShieldHealth (float shieldHealth)
 
void setShieldRechargeRate (float shieldRechargeRate)
 
void setShieldRechargeWaitTime (float shieldRechargeWaitTime)
 
void setSpawnParticleDuration (float duration)
 
void setSpawnParticleSource (const std::string &source)
 
void setVulnerable (bool bVulnerable)
 Sets the state of the pawns vulnerability. More...
 
virtual void startLocalHumanControl () override
 
void startShieldRechargeCountdown ()
 
virtual void XMLEventPort (Element &xmlelement, XMLPort::Mode mode) override
 Defines the possible event states of this object and parses eventsources from an XML file. More...
 
- Public Member Functions inherited from orxonox::ControllableEntity
 ControllableEntity (Context *context)
 
virtual ~ControllableEntity ()
 
void addCameraPosition (CameraPosition *position)
 
virtual void boost (bool bBoost)
 Tells the ControllableEntity to either start or stop boosting. More...
 
virtual void changedPlayer ()
 
void fire (unsigned int firemode)
 
CameragetCamera () const
 
CameraPositiongetCameraPosition (unsigned int index) const
 
const std::list< StrongPtr< CameraPosition > > & getCameraPositions () const
 
const std::string & getCameraPositionTemplate () const
 
ControllergetController () const
 
unsigned int getCurrentCameraIndex () const
 
CameraPositiongetCurrentCameraPosition ()
 
bool getDestroyWhenPlayerLeft () const
 
PlayerInfogetFormerPlayer () const
 Get the player even after the ControllableEntity has stopped being the players ControllableEntity. More...
 
OverlayGroupgetHUD () const
 
const std::string & getHudTemplate () const
 
float getMouseLookSpeed () const
 
PlayerInfogetPlayer () const
 
CameraPositiongetReverseCamera () const
 
virtual WorldEntitygetTarget ()
 
int getTeam () const
 
ControllergetXMLController () const
 
virtual void greet ()
 
bool hasHumanController () const
 
bool hasLocalController () const
 
bool isInMouseLook () const
 
virtual void mouseLook ()
 
virtual void moveFrontBack (const Vector2 &value)
 
void moveFrontBack (float value)
 
virtual void moveRightLeft (const Vector2 &value)
 
void moveRightLeft (float value)
 
virtual void moveUpDown (const Vector2 &value)
 
void moveUpDown (float value)
 
virtual void reload ()
 
void rotatePitch (float value)
 
void rotateRoll (float value)
 
void rotateYaw (float value)
 
virtual void setAngularVelocity (const Vector3 &velocity) override
 
bool setCameraPosition (unsigned int index)
 
void setCameraPositionTemplate (const std::string &name)
 
void setConfigValues ()
 
void setController (Controller *val)
 
void setDestroyWhenPlayerLeft (bool bDestroy)
 
virtual void setOrientation (const Quaternion &orientation) override
 
virtual void setPosition (const Vector3 &position) override
 
void setReverseCamera (CameraPosition *camera)
 
virtual void setTarget (WorldEntity *target)
 
void setTargetInternal (uint32_t targetID)
 
void setTeam (int team)
 
virtual void setVelocity (const Vector3 &velocity) override
 
virtual void switchCamera ()
 
- Public Member Functions inherited from orxonox::MobileEntity
 MobileEntity (Context *context)
 
virtual ~MobileEntity ()
 
void addAcceleration (const Vector3 &acceleration, const Vector3 &relativePosition=Vector3::ZERO)
 Adds the input acceleration at the input position to the MobileEntity. More...
 
void applyCentralForce (const Vector3 &force)
 
void applyCentralForce (float x, float y, float z)
 
const Vector3 & getAcceleration () const
 
const Vector3 & getAngularAcceleration () const
 
const Vector3 & getAngularVelocity () const
 
Vector3 getLocalVelocity () const
 Get the velocity in the coordinate-system of the MoblieEntity. More...
 
Vector3 getRotationAxis () const
 
Degree getRotationRate () const
 
virtual const Vector3 & getVelocity () const override
 
void setAcceleration (const Vector3 &acceleration)
 
void setAcceleration (float x, float y, float z)
 
void setAngularAcceleration (const Vector3 &acceleration)
 
void setAngularAcceleration (float x, float y, float z)
 
void setAngularVelocity (float x, float y, float z)
 
void setRotationAxis (const Vector3 &axis)
 
void setRotationRate (Degree rate)
 
void setVelocity (float x, float y, float z)
 
- Public Member Functions inherited from orxonox::WorldEntity
 WorldEntity (Context *context)
 Creates a new WorldEntity that may immediately be used. More...
 
virtual ~WorldEntity ()
 Destroys the WorldEntity AND ALL its children with it. More...
 
void activatePhysics ()
 Activates physics if the CollisionType is not None. More...
 
bool addedToPhysicalWorld () const
 Tells whether the object has already been added to the Bullet physics World. More...
 
void attach (WorldEntity *object)
 Attaches a child WorldEntity to this object. More...
 
void attachCollisionShape (CollisionShape *shape)
 Attaches a collision Shape to this object (delegated to the internal CompoundCollisionShape) More...
 
void attachNode (Ogre::SceneNode *node)
 Attaches an Ogre::SceneNode to this WorldEntity. More...
 
void attachOgreObject (Ogre::MovableObject *object)
 Attaches an Ogre::MovableObject to this WorldEntity. More...
 
void attachOgreObject (Ogre::BillboardSet *object)
 
void attachOgreObject (Ogre::Camera *object)
 
void attachOgreObject (Ogre::Entity *object)
 
void attachOgreObject (Ogre::ParticleSystem *object)
 
void attachToNode (Ogre::SceneNode *node)
 Attaches this object to a parent SceneNode. More...
 
void attachToParent (WorldEntity *parent)
 
 BT_DECLARE_ALIGNED_ALLOCATOR ()
 
virtual void changedActivity (void) override
 When the activity is changed, it is changed for all attached objects as well. More...
 
virtual void changedScale ()
 
virtual bool collidesAgainst (WorldEntity *otherObject, const btCollisionShape *ownCollisionShape, btManifoldPoint &contactPoint)
 Virtual function that gets called when this object collides with another. More...
 
void deactivatePhysics ()
 Deactivates physics but the CollisionType does not change. More...
 
void detach (WorldEntity *object)
 Detaches a child WorldEntity from this instance. More...
 
void detachCollisionShape (CollisionShape *shape)
 Detaches a collision Shape from this object (delegated to the internal CompoundCollisionShape) More...
 
void detachFromNode (Ogre::SceneNode *node)
 Detaches this object from a parent SceneNode. More...
 
void detachFromParent ()
 
void detachNode (Ogre::SceneNode *node)
 Detaches an Ogre::SceneNode from this WorldEntity. More...
 
void detachOgreObject (Ogre::MovableObject *object)
 Detaches an Ogre::MovableObject from this WorldEntity. More...
 
void detachOgreObject (Ogre::BillboardSet *object)
 
void detachOgreObject (Ogre::Camera *object)
 
void detachOgreObject (Ogre::Entity *object)
 
void detachOgreObject (Ogre::ParticleSystem *object)
 
Ogre::MovableObject * detachOgreObject (const Ogre::String &name)
 Detaches an Ogre::MovableObject (by string) from this WorldEntity. More...
 
void disableCollisionCallback ()
 Disables the collidesAgainst(.) function. More...
 
void enableCollisionCallback ()
 Enables the collidesAgainst(.) function. The object doesn't respond to collision otherwise! More...
 
float getAngularDamping () const
 Returns the angular damping. More...
 
float getAngularFactor () const
 Returns the angular factor. More...
 
CollisionShapegetAttachedCollisionShape (unsigned int index)
 Returns an attached collision Shape of this object (delegated to the internal CompoundCollisionShape) More...
 
WorldEntitygetAttachedObject (unsigned int index)
 Returns an attached object (merely for XMLPort). More...
 
const std::set< WorldEntity * > & getAttachedObjects () const
 
float getCcdMotionThreshold () const
 Returns the currently used motion threshold for CCD (0 means CCD is deactivated). More...
 
float getCcdSweptSphereRadius () const
 Returns the currently used radius of the sphere for CCD. More...
 
CollisionType getCollisionType () const
 Returns the CollisionType. More...
 
std::string getCollisionTypeStr () const
 Gets the CollisionType by string (used for the XMLPort) More...
 
bool getDeleteWithParent () const
 
float getFriction () const
 Returns the amount of friction applied to the object. More...
 
std::string getID (void)
 
float getLinearDamping () const
 Returns the linear damping. More...
 
const btVector3 & getLocalInertia () const
 Returns the diagonal elements of the inertia tensor when calculated in local coordinates. More...
 
float getMass () const
 Returns the mass of this object without its children. More...
 
const Ogre::SceneNode * getNode () const
 
const Quaternion & getOrientation () const
 
WorldEntitygetParent () const
 
const Vector3 & getPosition () const
 
float getRestitution () const
 Returns the restitution parameter. More...
 
float getScale () const
 
const Vector3 & getScale3D () const
 
float getTotalMass () const
 Returns the total mass of this object with all its attached children. More...
 
const Quaternion & getWorldOrientation () const
 Returns the orientation relative to the root space. More...
 
const Vector3 & getWorldPosition () const
 Returns the position relative to the root space. More...
 
float getWorldScale () const
 Returns the scaling applied relative to the root space in 3 coordinates. More...
 
const Vector3 & getWorldScale3D () const
 Returns the scaling applied relative to the root space in 3 coordinates. More...
 
bool hasCollisionResponse ()
 Tells whether there could be a collision response. More...
 
bool hasPhysics () const
 Tells whether the object has any connection to the Bullet physics engine. If hasPhysics() is false, the object may still have a velocity. More...
 
bool isCollisionCallbackActive () const
 Tells whether there could be a collision callback via collidesAgainst(.) More...
 
bool isDynamic () const
 
bool isKinematic () const
 
bool isPhysicsActive () const
 Tells whether physics has been activated (you can temporarily deactivate it) More...
 
bool isStatic () const
 
void lookAt (const Vector3 &target, TransformSpace relativeTo=TransformSpace::Parent, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 Makes this WorldEntity look at a specific target location. More...
 
void notifyChildMassChanged ()
 Recalculates the accumulated child mass and calls recalculateMassProps() and notifies the parent of the change. More...
 
void notifyChildPropsChanged ()
 
void notifyCollisionShapeChanged ()
 Undertakes the necessary steps to change the collision shape in Bullet, even at runtime. More...
 
void pitch (const Degree &angle, TransformSpace relativeTo=TransformSpace::Local)
 
void roll (const Degree &angle, TransformSpace relativeTo=TransformSpace::Local)
 
void rotate (const Quaternion &rotation, TransformSpace relativeTo=TransformSpace::Local)
 Rotates this WorldEntity by a quaternion. More...
 
void rotate (const Vector3 &axis, const Degree &angle, TransformSpace relativeTo=TransformSpace::Local)
 
void scale (float scale)
 
void scale3D (const Vector3 &scale)
 
void scale3D (float x, float y, float z)
 
void setAngularDamping (float angularDamping)
 Applies a tensor independent rotation damping. Angular velocities will simply diminish exponentially. More...
 
void setAngularFactor (float angularFactor)
 Sets an artificial parameter that tells how much torque is applied when you apply a non-central force. More...
 
void setCcdMotionThreshold (float ccdMotionThreshold)
 Sets the motion threshold for continuous collision detection (CCD). More...
 
void setCcdSweptSphereRadius (float ccdSweptSphereRadius)
 Sets the radius of the sphere which is used for continuous collision detection (CCD). More...
 
void setCollisionResponse (bool value)
 Enables or disables collision response (default is of course on) More...
 
void setCollisionType (CollisionType type)
 Sets the CollisionType. More...
 
void setCollisionTypeStr (const std::string &type)
 Sets the CollisionType by string (used for the XMLPort) More...
 
void setDeleteWithParent (bool value)
 
void setDirection (const Vector3 &direction, TransformSpace relativeTo=TransformSpace::Local, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 Makes this WorldEntity look in specific direction. More...
 
void setDirection (float x, float y, float z, TransformSpace relativeTo=TransformSpace::Local, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 
void setFriction (float friction)
 Applies friction to the object. Friction occurs when two objects collide. More...
 
void setID (std::string id)
 
void setLinearDamping (float linearDamping)
 Applies a mass independent damping. Velocities will simply diminish exponentially. More...
 
void setMass (float mass)
 Sets the mass of this object. Note that the total mass may be influenced by attached objects! More...
 
void setOrientation (float w, float x, float y, float z)
 
void setOrientation (const Vector3 &axis, const Radian &angle)
 
void setOrientation (const Vector3 &axis, const Degree &angle)
 
void setPosition (float x, float y, float z)
 
void setRestitution (float restitution)
 Sets how much reaction is applied in a collision. More...
 
void setScale (float scale)
 
virtual void setScale3D (const Vector3 &scale)
 Sets the three dimensional scaling of this object. More...
 
void setScale3D (float x, float y, float z)
 
void translate (const Vector3 &distance, TransformSpace relativeTo=TransformSpace::Parent)
 Translates this WorldEntity by a vector. More...
 
void translate (float x, float y, float z, TransformSpace relativeTo=TransformSpace::Parent)
 
void yaw (const Degree &angle, TransformSpace relativeTo=TransformSpace::Local)
 
- 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 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...
 
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...
 
- 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...
 
- 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 ()
 
- Public Member Functions inherited from orxonox::RadarViewable
 RadarViewable (BaseObject *creator, const WorldEntity *wePtr)
 Constructor. More...
 
virtual ~RadarViewable ()
 
const std::string & getRadarName () const
 
float getRadarObjectCamouflage () const
 
const ColourValue & getRadarObjectColour () const
 
float getRadarObjectScale () const
 
Shape getRadarObjectShape () const
 
bool getRadarVisibility () const
 
Vector3 getRVOrientedVelocity () const
 
Vector3 getRVVelocity () const
 
const Vector3 & getRVWorldPosition () const
 
const std::string & getUniqueId ()
 
virtual const WorldEntitygetWorldEntity () const
 
virtual void setRadarName (const std::string &name)
 
void setRadarObjectCamouflage (float camouflage)
 
void setRadarObjectColour (const ColourValue &colour)
 
void setRadarObjectScale (float scale)
 
void setRadarObjectShape (Shape shape)
 
void setRadarVisibility (bool b)
 
void settingsChanged ()
 
- Public Member Functions inherited from orxonox::PickupCarrier
 PickupCarrier ()
 Constructor. More...
 
virtual ~PickupCarrier ()
 Destructor. More...
 
PickupCarriergetTarget (const Pickupable *pickup)
 Get the carrier that is both a child of the PickupCarrier (or the PickupCarrier itself) and a target of the input Pickupable. More...
 
bool isTarget (const Pickupable *pickup) const
 Can be used to check whether the PickupCarrier or a child of his is a target ot the input Pickupable. More...
 

Protected Attributes

Vector3 localX_
 The local x-axis, includes for the parent's rotation and rotations done in xml. More...
 
Vector3 localY_
 The local y-axis, includes for the parent's rotation and rotations done in xml. More...
 
Vector3 localZ_
 The local z-axis, includes for the parent's rotation and rotations done in xml. More...
 
Quaternion rotation_
 The rotation to be done by the turret. More...
 
Vector3 startDir_
 The initial facing direction, in local coordinates. More...
 
- Protected Attributes inherited from orxonox::Pawn
bool acceptsPickups_
 
bool bAlive_
 
bool bVulnerable_
 If this is false, then the pawn may not take damage. More...
 
float damageMultiplier_
 Used by the Damage Boost Pickup. More...
 
std::vector< ExplosionPart * > explosionPartList_
 
float health_
 
float initialHealth_
 
float initialShieldHealth_
 
WeakPtr< PawnlastHitOriginator_
 
float maxHealth_
 
float maxShieldHealth_
 
unsigned int numexplosionchunks_
 
float shieldAbsorption_
 Has to be between 0 and 1. More...
 
float shieldHealth_
 
float shieldRechargeRate_
 
float shieldRechargeWaitCountdown_
 
float shieldRechargeWaitTime_
 
float spawnparticleduration_
 
std::string spawnparticlesource_
 
WeaponSystemweaponSystem_
 
- Protected Attributes inherited from orxonox::ControllableEntity
Ogre::SceneNode * cameraPositionRootNode_
 
- Protected Attributes inherited from orxonox::MobileEntity
Vector3 angularAcceleration_
 
Vector3 angularVelocity_
 
Vector3 linearAcceleration_
 
Vector3 linearVelocity_
 
- Protected Attributes inherited from orxonox::WorldEntity
std::string id_
 Used by the ScriptableController to identify objects. More...
 
Ogre::SceneNode * node_
 
btRigidBody * physicalBody_
 Bullet rigid body. Everything physical is applied to this instance. 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...
 

Private Attributes

Vector3 localXStart_
 The local x-axis, without the parent's rotation. More...
 
Vector3 localYStart_
 The local y-axis, without the parent's rotation. More...
 
Vector3 localZStart_
 The local z-axis, without the parent's rotation. More...
 
float maxAttackRadius_
 The maximum distance the turret is allowed to shoot. More...
 
Ogre::Real maxPitch_
 The maxmium pitch the turret can have (on one side). More...
 
Ogre::Real maxYaw_
 The maxmium yaw the turret can have (on one side). More...
 
float minAttackRadius_
 The minimum distance the turret is allowed to shoot. More...
 
bool once_
 Flag for executing code in the tick function only once. More...
 
Ogre::RaySceneQuery * rayTest_
 Used to perform a raytest, currently unused. More...
 
float rotationThrust_
 The velocity the turret rotates with. More...
 

Additional Inherited Members

- Public Types inherited from orxonox::WorldEntity
enum  CollisionType { CollisionType::Dynamic, CollisionType::Kinematic, CollisionType::Static, CollisionType::None }
 Denotes the possible types of physical objects in a Scene. More...
 
enum  TransformSpace { TransformSpace::Local, TransformSpace::Parent, TransformSpace::World }
 Enumeration denoting the spaces which a transform can be relative to. More...
 
- Public Types inherited from orxonox::RadarViewable
enum  Shape { Shape::Square, Shape::Dot, Shape::Triangle }
 
- Static Public Member Functions inherited from orxonox::Pawn
static void consoleCommand_debugDrawWeapons (bool bDraw)
 
- 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 Synchronisablefabricate (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 SynchronisablegetSynchronisable (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...
 
- Public Attributes inherited from orxonox::RadarViewable
bool isHumanShip_
 
- Static Public Attributes inherited from orxonox::WorldEntity
static const Vector3 BACK = Vector3::UNIT_Z
 
static const Vector3 DOWN = Vector3::NEGATIVE_UNIT_Y
 
static const Vector3 FRONT = Vector3::NEGATIVE_UNIT_Z
 
static const Vector3 LEFT = Vector3::NEGATIVE_UNIT_X
 
static const Vector3 RIGHT = Vector3::UNIT_X
 
static const Vector3 UP = Vector3::UNIT_Y
 
- Protected Member Functions inherited from orxonox::Pawn
virtual void damage (float damage, float healthdamage=0.0f, float shielddamage=0.0f, Pawn *originator=nullptr, const btCollisionShape *cs=nullptr)
 
virtual void death ()
 
virtual std::vector< PickupCarrier * > * getCarrierChildren (void) const override
 Get all direct children of this PickupSpawner. More...
 
virtual PickupCarriergetCarrierParent (void) const override
 Get the parent of this PickupSpawner. More...
 
virtual ControllergetSlave ()
 
virtual void goWithStyle ()
 
virtual bool hasSlaves ()
 
virtual void preDestroy () override
 Is called before the PickupCarrier is effectively destroyed. More...
 
virtual void removePlayer () override
 
virtual void setPlayer (PlayerInfo *player) override
 
virtual void spawneffect ()
 
- Protected Member Functions inherited from orxonox::ControllableEntity
void createHud (void)
 
void destroyHud (void)
 
virtual void parentChanged () override
 
void setHudTemplate (const std::string &name)
 
virtual void stopLocalHumanControl ()
 
- Protected Member Functions inherited from orxonox::MobileEntity
virtual void getWorldTransform (btTransform &worldTrans) const override
 
- 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::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)
 
- Protected Member Functions inherited from orxonox::Tickable
 Tickable ()
 Constructor: Registers the object in the Tickable-list. More...
 
- Protected Member Functions inherited from orxonox::PickupCarrier
std::set< Pickupable * > & getPickups (void)
 Get all Pickupables this PickupCarrier has. More...
 

Detailed Description

Creates a turret with limited rotation.

The point of this class is to be able to attach a turret to a spaceship or a spacestation which is more or less completely autonomous in it's behaviour.

This class also contains a custom local coordinate system, which gets initially rotated through xml, and afterwards is updated with the parent's rotation (if there is one). This allows for almost trivialal calculation of pitch, yaw and roll through coordinate transformation. (TODO: Ogre should do something like this already, investigate...)

Note
The rotation isn't limited "physically". You have to call isInRange to find out if the turret is allowed to shoot at a target.

Constructor & Destructor Documentation

orxonox::Turret::Turret ( Context context)

Sets default values for all variables.

Also hides the turret from the radar.

Parameters
contextThe context
orxonox::Turret::~Turret ( )
virtual

Destructor.

Destroys the rayTest_ element (if it was used) .

Member Function Documentation

void orxonox::Turret::aimAtPosition ( const Vector3 &  position)
virtual

Rotates the turret to make it aim at a certain position.

Note
There are no checks, if the position is valid (i.e. if the turret is allowed to aim there). This function must be called again for every tick, or the turret will stop rotating.
Parameters
positionThe position to aim at
float orxonox::Turret::getMaxAttackRadius ( ) const
inline

Returns the maximum distance the turret is allowed to shoot.

Returns
The distance
float orxonox::Turret::getMaxPitch ( ) const
inline

Returns the maximum pitch the turret can have.

Returns
The pitch
float orxonox::Turret::getMaxYaw ( ) const
inline

Returns the maximum yaw the turret can have.

Returns
The yaw
float orxonox::Turret::getMinAttackRadius ( ) const
inline

Returns the minimum distance the turret is allowed to shoot.

Returns
The distance
float orxonox::Turret::getRotationThrust ( )
inline
float orxonox::Turret::isInRange ( const WorldEntity target)
virtual

Checks, if a WorldEntity is inside the turret's range.

This function is safe to use on turrets that are attached, rotated, etc. The turret's range is determined with the maxPitch, maxYaw, and the two attackRadius.

Parameters
targetThe WorldEntity to check
Returns
The squared distance to the position. -1, if it's ouside of range
void orxonox::Turret::rotatePitch ( const Vector2 &  value)
overridevirtual

Does currently nothing.

Should rotate the turret with the specified pitch. Contains a failed attempt at limiting said rotation.

Reimplemented from orxonox::ControllableEntity.

void orxonox::Turret::rotateRoll ( const Vector2 &  value)
overridevirtual

Does currently nothing.

May be used to limit turret's rotation in the future.

Reimplemented from orxonox::ControllableEntity.

void orxonox::Turret::rotateYaw ( const Vector2 &  value)
overridevirtual

Does currently nothing.

Should rotate the turret with the specified yaw. Contains a failed attempt at limiting said rotation.

Reimplemented from orxonox::ControllableEntity.

void orxonox::Turret::setMaxAttackRadius ( float  radius)
inline

Sets the maximum distance the turret is allowed to shoot.

Parameters
radiusThe distance
void orxonox::Turret::setMaxPitch ( float  pitch)
inline

Sets the maximum pitch the turret can have (in both directions).

Parameters
pitchThe pitch (in one direction)
void orxonox::Turret::setMaxYaw ( float  yaw)
inline

Sets the maximum yaw the turret can have (in both directions).

Parameters
yawThe yaw (in one direction)
void orxonox::Turret::setMinAttackRadius ( float  radius)
inline

Sets the minimum distance the turret is allowed to shoot.

Parameters
radiusThe distance
void orxonox::Turret::setRotationThrust ( float  rotationthrust)
inline
void orxonox::Turret::tick ( float  dt)
overridevirtual

The turret's actions are done here.

Every tick, the turret gets rotated if it should, and the local axes get updated with the parent's rotation.

Parameters
dtDuration of the tick

Reimplemented from orxonox::Pawn.

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

Loads parameters from xml.

Parameters loaded are: rotationThrust, maxAttackRadius, minAttackRadius, maxYaw, maxPitch

Reimplemented from orxonox::Pawn.

Member Data Documentation

Vector3 orxonox::Turret::localX_
protected

The local x-axis, includes for the parent's rotation and rotations done in xml.

Vector3 orxonox::Turret::localXStart_
private

The local x-axis, without the parent's rotation.

Vector3 orxonox::Turret::localY_
protected

The local y-axis, includes for the parent's rotation and rotations done in xml.

Vector3 orxonox::Turret::localYStart_
private

The local y-axis, without the parent's rotation.

Vector3 orxonox::Turret::localZ_
protected

The local z-axis, includes for the parent's rotation and rotations done in xml.

Vector3 orxonox::Turret::localZStart_
private

The local z-axis, without the parent's rotation.

float orxonox::Turret::maxAttackRadius_
private

The maximum distance the turret is allowed to shoot.

Ogre::Real orxonox::Turret::maxPitch_
private

The maxmium pitch the turret can have (on one side).

Ogre::Real orxonox::Turret::maxYaw_
private

The maxmium yaw the turret can have (on one side).

float orxonox::Turret::minAttackRadius_
private

The minimum distance the turret is allowed to shoot.

bool orxonox::Turret::once_
private

Flag for executing code in the tick function only once.

Ogre::RaySceneQuery* orxonox::Turret::rayTest_
private

Used to perform a raytest, currently unused.

See also
isInRange
Quaternion orxonox::Turret::rotation_
protected

The rotation to be done by the turret.

float orxonox::Turret::rotationThrust_
private

The velocity the turret rotates with.

Vector3 orxonox::Turret::startDir_
protected

The initial facing direction, in local coordinates.


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