Changeset 7601 for code/trunk/src/modules/objects/triggers/Trigger.h

Timestamp:

Oct 30, 2010, 1:54:49 PM (14 years ago)

Author:

dafrick

Message:

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

File:

• code/trunk/src/modules/objects/triggers/Trigger.h (modified) (5 diffs)

code/trunk/src/modules/objects/triggers/Trigger.h

@@ -27 +27 @@
  */
 
+/**
+    @file Trigger.h
+    @brief Definition of the Trigger class.
+    @ingroup NormalTrigger
+*/
+
 #ifndef _Trigger_H__
 #define _Trigger_H__
@@ -36 +42 @@
 
 #include "tools/BillboardSet.h"
-#include "tools/interfaces/Tickable.h"
-#include "worldentities/StaticEntity.h"
+
+#include "TriggerBase.h"
 
 namespace orxonox
 {
-  namespace TriggerMode
-  {
-    enum Value
-    {
-      EventTriggerAND,
-      EventTriggerOR,
-      EventTriggerXOR,
-    };
-  }
 
-  class _ObjectsExport Trigger : public StaticEntity, public Tickable
+  /**
+  @brief
+    
+  @author
+    Benjamin Knecht
+
+  @ingroup NormalTrigger
+  */
+  class _ObjectsExport Trigger : public TriggerBase
   {
     public:
@@ -60 +65 @@
       virtual void tick(float dt);
 
-      inline bool isActive() const
-        { return bActive_; }
-
-      void addTrigger(Trigger* trigger);
-      const Trigger* getTrigger(unsigned int index) const;
-
-      void setMode(const std::string& modeName);
-      inline void setMode(TriggerMode::Value mode)
-        { this->mode_ = mode; }
-      inline TriggerMode::Value getMode() const
-        { return mode_; }
-
-      inline void setInvert(bool bInvert)
-        { this->bInvertMode_ = bInvert; }
-      inline bool getInvert() const
-        { return this->bInvertMode_; }
-
-      inline void setSwitch(bool bSwitch)
-        { this->bSwitch_ = bSwitch; }
-      inline bool getSwitch() const
-        { return this->bSwitch_; }
-
-      inline void setStayActive(bool bStayActive)
-        { this->bStayActive_ = bStayActive; }
-      inline bool getStayActive() const
-        { return this->bStayActive_; }
-
-      inline void setActivations(int activations)
-        { this->remainingActivations_ = activations; }
-      inline int getActivations() const
-        { return this->remainingActivations_; }
+      inline bool isActive(void) const
+        { return this->bActive_; }
 
       inline void setVisible(bool visibility)
         { this->debugBillboard_.setVisible(visibility); }
 
-      void setDelay(float delay);
-      inline float getDelay() const
-        { return this->delay_; }
+      void delayChanged(void);
 
       bool switchState();
@@ -115 +89 @@
       void setBillboardColour(const ColourValue& colour);
       void storeState();
-      std::string getModeString() const;
 
       bool bActive_;
       bool bTriggered_;
-      bool bFirstTick_;
-
-      TriggerMode::Value mode_;
-      bool bInvertMode_;
-      bool bSwitch_;
-      bool bStayActive_;
-      float delay_;
-      int remainingActivations_;
 
       char latestState_;
@@ -135 +100 @@
       BillboardSet debugBillboard_;
 
-      std::set<Trigger*> children_;
       std::queue<std::pair<float, char> > stateChanges_;
   };