Changeset 5091 in orxonox.OLD for trunk/src/lib/coord

Timestamp:

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

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

File:

• trunk/src/lib/coord/p_node.cc (modified) (12 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)
 */