Changeset 11331 for code/branches/Dialog_HS16/src/modules/overlays/hud

Timestamp:

Dec 12, 2016, 3:16:38 PM (8 years ago)

Author:

dmoritz

Message:

Final changes.

Location:

code/branches/Dialog_HS16/src/modules/overlays/hud

Files:

• HUDDialogue.cc (modified) (3 diffs)
• HUDDialogue.h (modified) (2 diffs)

code/branches/Dialog_HS16/src/modules/overlays/hud/HUDDialogue.cc

@@ -15 +15 @@
 {
 
-         RegisterClass (HUDDialogue);
-
-         HUDDialogue::HUDDialogue(Context* context) :
-        OrxonoxOverlay(context)
+        RegisterClass (HUDDialogue);
+        /**
+    @brief
+        Default Constructor. Registers the object and initializes variables.
+    */
+        HUDDialogue::HUDDialogue(Context* context) :
+    OrxonoxOverlay(context)
     {
         RegisterObject(HUDDialogue);
-        }     
+        }   
+        /**
+        @brief
+                Updates the picture to the picture which was declared in the Dialogue class and sets a timer to set the picture on invisible again.
+        */  
     void HUDDialogue::updateTarget(std::string portrait)
     {
@@ -33 +40 @@
         portraitTimer.setTimer(2.9f,false,createExecutor(createFunctor(&HUDDialogue::invisible, this)));
     }
+    /**
+    @brief
+        Sets the picture back to invisible again.
+    */
     void HUDDialogue::invisible()
     {
@@ -38 +49 @@
         Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->overlayElementIcon_);
     }
-         HUDDialogue::~HUDDialogue()
-         {
+    /**
+    @brief
+        Default Destructor.
+    */
+        HUDDialogue::~HUDDialogue()
+        {
 
 
-         }
+        }
 }

code/branches/Dialog_HS16/src/modules/overlays/hud/HUDDialogue.h

@@ -18 +18 @@
     {
         public:
-            HUDDialogue(Context* context);
-            virtual ~HUDDialogue();
+            HUDDialogue(Context* context); //!< Default Constructor.
+            virtual ~HUDDialogue(); //!< Destructor.
 
+            /**
+            @brief Sets the active picture.
+            */
             virtual void updateTarget(std::string portrait);
-
+            /**
+            @brief Sets the picture to invivsible when Dialogue is over.
+            */
             virtual void invisible();
 
@@ -28 +33 @@
                         Ogre::PanelOverlayElement* overlayElementIcon_;
 
-                        Timer portraitTimer;
+                        Timer portraitTimer; //!< The Timer which is used to set the picture back to invisible.
     };
 }