Changeset 5091 in orxonox.OLD for trunk

Timestamp:

Aug 21, 2005, 10:14:59 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

Location:

trunk/src/lib

Files:

• coord/p_node.cc (modified) (12 diffs)
• graphics/render2D/element_2d.cc (modified) (30 diffs)

trunk/src/lib/coord/p_node.cc

@@ -147 +147 @@
     while (element != NULL)
     {
-      LoadParam<PNode>(root, "parent", this, &PNode::addChild, true)
+      LoadParam<PNode>(element, "parent", this, &PNode::addChild, true)
           .describe("adds a new Child to the current Node.");
 
@@ -210 +210 @@
 /**
  * @param absCoord set absolute coordinate
-
-   it is very importand, that you use this function, if you want to update the
-   absCoordinates. If you don't use this, the PNode won't recognize, that something
-   has changed and won't update the children Nodes.
-
-@todo check if this does what it should
-*/
+ */
 void PNode::setAbsCoor (const Vector& absCoord)
 {
@@ -251 +245 @@
 
 /**
- *  shift coordinate (abs and rel)
+ *  shift coordinate relative
  * @param shift shift vector
 
@@ -269 +263 @@
    yea right... shorter...
  *
- * @todo this is ambiguous, from the outside one does not know it absCoor has been changed
- * this might lead to strange artefacts !!
-
 */
 void PNode::shiftCoor (const Vector& shift)
@@ -282 +273 @@
  *  set relative direction
  * @param relDir to its parent
-
-   it is very importand, that you use this function, if you want to update the
-   relDirection. If you don't use this, the PNode won't recognize, that something
-   has changed and won't update the children Nodes.
-*/
+ */
 void PNode::setRelDir (const Quaternion& relDir)
 {
@@ -335 +322 @@
 
 /**
- *  sets the absolute direction (0,0,1)
+ *  sets the absolute direction
  * @param absDir absolute coordinates
- *
- * it is very importand, that you use this function, if you want to update the
- * absDirection. If you don't use this, the PNode won't recognize, that something
- * has changed and won't update the children Nodes.
-*/
+ */
 void PNode::setAbsDir (const Quaternion& absDir)
 {
@@ -366 +349 @@
 
 /**
- *  shift coordinate (abs and rel)
- * @param shift vector
- * @todo implement this
-*/
+ * shift Direction
+ * @param shift the direction around which to shift.
+ */
 void PNode::shiftDir (const Quaternion& shift)
 {
@@ -378 +360 @@
 /**
  *  adds a child and makes this node to a parent
- * @param pNode child reference
+ * @param child child reference
  * @param parentMode on which changes the child should also change ist state
  *
@@ -397 +379 @@
 
 /**
- * @see PNode::addChild(PNode* parent);
+ * @see PNode::addChild(PNode* child);
  * @param childName the name of the child to add to this PNode
  */
@@ -409 +391 @@
 /**
  *  removes a child from the node
- * @param pNode the child to remove from this pNode.
+ * @param child the child to remove from this pNode.
  *
  * Children from pNode will not be lost, they are referenced to NullPointer
@@ -423 +405 @@
  *  remove this pnode from the tree and adds all following to NullParent
 
-   this can be the case, if an entity in the world is been destroyed.
+   this can be the case, if an entity in the world is being destroyed.
 */
 void PNode::remove()
@@ -623 +605 @@
  *  displays some information about this pNode
  * @param depth The deph into which to debug the children of this PNode to.
-  (0: all children will be debugged, 1: only this PNode, 2: this and direct children...)
+ * (0: all children will be debugged, 1: only this PNode, 2: this and direct children...)
  * @param level The n-th level of the Node we draw (this is internal and only for nice output)
 */

trunk/src/lib/graphics/render2D/element_2d.cc

@@ -119 +119 @@
       .describe("if the Element is visible or not");
 
-//   LoadParam<Element2D>(root, "2d-position", this, &Element2D::setPosition2D)
-//       .describe("the _relative_ position (away from alignment) this 2d-element shows");
-
+
+  // PNode-style:
+  LoadParam<Element2D>(root, "rel-coor", this, &Element2D::setRelCoor2D)
+      .describe("Sets The relative position of the Node to its parent.");
+
+  LoadParam<Element2D>(root, "abs-coor", this, &Element2D::setAbsCoor2D)
+      .describe("Sets The absolute Position of the Node.");
+
+  LoadParam<Element2D>(root, "rel-dir", this, &Element2D::setRelDir2D)
+      .describe("Sets The relative rotation of the Node to its parent.");
+
+  LoadParam<Element2D>(root, "abs-dir", this, &Element2D::setAbsDir2D)
+      .describe("Sets The absolute rotation of the Node.");
+
+  LoadParam<Element2D>(root, "parent", this, &Element2D::setParent2D)
+      .describe("the Name of the Parent of this Element2D");
+
+  LoadParam<Element2D>(root, "parent-mode", this, &Element2D::setParentMode2D)
+      .describe("the mode to connect this node to its parent ()");
+
+  // cycling properties
+  if (root != NULL)
+  {
+    const TiXmlElement* element = root->FirstChildElement();
+    while (element != NULL)
+    {
+      LoadParam<Element2D>(root, "parent", this, &Element2D::addChild2D, true)
+          .describe("adds a new Child to the current Node.");
+
+      element = element->NextSiblingElement();
+    }
+  }
 }
 
@@ -179 +208 @@
 }
 
-
+/**
+ * sets the relative coordinate of the Element2D to its parent
+ * @param relCoord the relative coordinate to the parent
+ */
 void Element2D::setRelCoor2D (const Vector& relCoord)
 {
@@ -187 +219 @@
 
 
+/**
+ * sets the relative coordinate of the Element2D to its Parent
+ * @param x the x coordinate
+ * @param y the y coordinate
+ * @param z the z coordinate
+ */
 void Element2D::setRelCoor2D (float x, float y, float z)
 {
@@ -192 +230 @@
 }
 
+/**
+ * sets the Relative coordinate to the parent in Pixels
+ * @param x the relCoord X
+ * @param y the relCoord Y
+ */
 void Element2D::setRelCoor2Dpx (int x, int y)
 {
@@ -200 +243 @@
 }
 
-
+/**
+ * sets a new relative position smoothely
+ * @param relCoordSoft the new Position to iterate to
+ * @param bias how fast to iterate to this position
+ */
 void Element2D::setRelCoorSoft2D(const Vector& relCoordSoft, float bias)
 {
@@ -210 +257 @@
 }
 
+/**
+ * sets a new relative position smoothely
+ * @param x the new x-coordinate in Pixels of the Position to iterate to
+ * @param y the new y-coordinate in Pixels of the Position to iterate to
+ * @param bias how fast to iterate to this position
+ */
 void Element2D::setRelCoorSoft2Dpx (int x, int y, float bias)
 {
@@ -218 +271 @@
 }
 
-
+/**
+ * set relative coordinates smoothely
+ * @param x x-relative coordinates to its parent
+ * @param y y-relative coordinates to its parent
+ * @param z z-relative coordinates to its parent
+ * @see  void PNode::setRelCoorSoft (const Vector&, float)
+ */
 void Element2D::setRelCoorSoft2D(float x, float y, float depth, float bias)
 {
@@ -224 +283 @@
 }
 
+/**
+ * @param absCoord set absolute coordinate
+ */
 void Element2D::setAbsCoor2D (const Vector& absCoord)
 {
@@ -245 +307 @@
 }
 
+/**
+ * @param x x-coordinate.
+ * @param y y-coordinate.
+ * @param z z-coordinate.
+ * @see void PNode::setAbsCoor (const Vector& absCoord)
+ */
 void Element2D::setAbsCoor2D (float x, float y, float depth)
 {
@@ -250 +318 @@
 }
 
-
+/**
+ * @param x x-coordinate in Pixels
+ * @param y y-coordinate in Pixels
+ * @see void PNode::setAbsCoor (const Vector& absCoord)
+ */
 void Element2D::setAbsCoor2Dpx (int x, int y)
 {
@@ -259 +331 @@
 }
 
+/**
+ *  shift coordinate ralative
+ * @param shift shift vector
+ *
+ * This simply adds the shift-Vector to the relative Coordinate
+ */
 void Element2D::shiftCoor2D (const Vector& shift)
 {
@@ -266 +344 @@
 }
 
-
+/**
+ * shifts in PixelSpace
+ * @param x the pixels to shift in X
+ * @param y the pixels to shift in Y
+ */
 void Element2D::shiftCoor2Dpx (int x, int y)
 {
@@ -274 +356 @@
 }
 
-
+/**
+ *  set relative direction
+ * @param relDir to its parent
+ */
 void Element2D::setRelDir2D (float relDir)
 {
@@ -281 +366 @@
 }
 
+/**
+ * sets the Relative Direction of this node to its parent in a Smoothed way
+ * @param relDirSoft the direction to iterate to smoothely.
+ * @param bias how fast to iterate to the new Direction
+ */
 void Element2D::setRelDirSoft2D(float relDirSoft, float bias)
 {
@@ -290 +380 @@
 }
 
+/**
+ *  sets the absolute direction
+ * @param absDir absolute coordinates
+ */
 void Element2D::setAbsDir2D (float absDir)
 {
@@ -300 +394 @@
 }
 
+/**
+ * shift Direction
+ * @param shift the direction around which to shift.
+ */
 void Element2D::shiftDir2D (float shiftDir)
 {
@@ -306 +404 @@
 }
 
-
+/**
+ *  adds a child and makes this node to a parent
+ * @param child child reference
+ * @param parentMode on which changes the child should also change ist state
+ *
+ * use this to add a child to this node.
+ */
 void Element2D::addChild2D (Element2D* child, int parentingMod)
 {
@@ -320 +424 @@
 }
 
+/**
+ * @see Element2D::addChild(Element2D* child);
+ * @param childName the name of the child to add to this PNode
+ */
 void Element2D::addChild2D (const char* childName)
 {
@@ -327 +435 @@
 }
 
+/**
+ * removes a child from the node
+ * @param child the child to remove from this Node..
+ *
+ * Children from nodes will not be lost, they are referenced to NullPointer
+ */
 void Element2D::removeChild2D (Element2D* child)
 {
@@ -334 +448 @@
 }
 
+/**
+ * remove this pnode from the tree and adds all following to NullParent
+ *
+ * this can be the case, if an entity in the world is being destroyed.
+ */
 void Element2D::remove2D()
 {
@@ -348 +467 @@
 }
 
-
+/**
+ * sets the parent of this Element2D
+ * @param parent the Parent to set
+ */
 void Element2D::setParent2D (Element2D* parent)
 {
@@ -354 +476 @@
 }
 
+/**
+ * @see Element2D::setParent(Element2D* parent);
+ * @param parentName the name of the Parent to set to this Element2D
+ */
 void Element2D::setParent2D (const char* parentName)
 {
@@ -362 +488 @@
 }
 
-
+/**
+ * does the reparenting in a very smooth way
+ * @param parentNode the new Node to connect this node to.
+ * @param bias the speed to iterate to this new Positions
+ */
 void Element2D::softReparent2D(Element2D* parentNode, float bias)
 {
@@ -394 +524 @@
 }
 
+/**
+ * does the reparenting in a very smooth way
+ * @param parentName the name of the Parent to reconnect to
+ * @param bias the speed to iterate to this new Positions
+ */
 void Element2D::softReparent2D(const char* parentName, float bias)
 {
@@ -401 +536 @@
 }
 
-
+/**
+ *  sets the mode of this parent manually
+ * @param parentMode a String representing this parentingMode
+ */
 void Element2D::setParentMode2D (const char* parentingMode)
 {
@@ -407 +545 @@
 }
 
-
+/**
+ *  updates the absCoordinate/absDirection
+ * @param dt The time passed since the last update
+
+   this is used to go through the parent-tree to update all the absolute coordinates
+   and directions. this update should be done by the engine, so you don't have to
+   worry, normaly...
+ */
 void Element2D::update2D (float dt)
 {
@@ -541 +686 @@
 }
 
-
+/**
+ *  displays some information about this pNode
+ * @param depth The deph into which to debug the children of this Element2D to.
+ * (0: all children will be debugged, 1: only this Element2D, 2: this and direct children...)
+ * @param level The n-th level of the Node we draw (this is internal and only for nice output)
+ */
 void Element2D::debug (unsigned int depth, unsigned int level) const
 {
@@ -578 +728 @@
 #include "color.h"
 
+/**
+ * displays the Element2D at its position with its rotation as a Plane.
+ */
 void Element2D::debugDraw2D(unsigned int depth, float size, Vector color) const
 {
@@ -585 +738 @@
 
 // helper functions //
+/**
+ * converts a parentingMode into a string that is the name of it
+ * @param parentingMode the ParentingMode to convert
+ * @return the converted string
+ */
 const char* Element2D::parentingModeToChar2D(int parentingMode)
 {
@@ -599 +757 @@
 }
 
+/**
+ * converts a parenting-mode-string into a int
+ * @param parentingMode the string naming the parentingMode
+ * @return the int corresponding to the named parentingMode
+ */
 E2D_PARENT_MODE Element2D::charToParentingMode2D(const char* parentingMode)
 {