Changeset 5391 in orxonox.OLD for trunk/src/lib/coord/p_node.h

Timestamp:

Oct 16, 2005, 1:37:41 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: more gui-definitions

File:

• trunk/src/lib/coord/p_node.h (modified) (1 diff)

trunk/src/lib/coord/p_node.h

@@ -1 +1 @@
 /*!
-    @file p_node.h
-  *  Definition of a parenting node
-
-    parenting is how coordinates are handled in orxonox, meaning, that all coordinates
-    are representet relative to another parent node. this nodes build a parenting
-    tree of one-sided references (from up to down referenced).
-    Every node manages itself a list of childrens (of whos it is parent - easy...)
-
-    absCoordinate, absDirection have to be recalculated as soon as there was a change in
-    place or ortientation. this is only the case if
-    o bDirChanged is true (so changed) AND timeStamp != now
-    o bCoorChanged is true (so moved) AND timeStamp != now
-    this conditions make it cheaper to recalculate the tree (reduces redundant work).
-
-    remember: if you have to change the coordinates or the directions, use the functions
-    that are defined to execute this operation - otherwhise there will be big problems...
-*/
+ * @file p_node.h
+ * @brief  Definition of a parenting node
+ *
+ *  parenting is how coordinates are handled in orxonox, meaning, that all coordinates
+ *  are representet relative to another parent node. this nodes build a parenting
+ *  tree of one-sided references (from up to down referenced).
+ *  Every node manages itself a list of childrens (of whos it is parent - easy...).
+ *
+ *  absCoordinate, absDirection have to be recalculated as soon as there was a change in
+ *  place or ortientation. this is only the case if
+ *  o bDirChanged is true (so changed) AND timeStamp != now
+ *  o bCoorChanged is true (so moved) AND timeStamp != now
+ *  this conditions make it cheaper to recalculate the tree (reduces redundant work).
+ */