Changeset 3450 in orxonox.OLD for orxonox/trunk/src/p_node.cc

Timestamp:

Mar 2, 2005, 4:10:19 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags: player.cc/h p_node.cc/h base_entity.h skysphere.cc/h

File:

• orxonox/trunk/src/p_node.cc (modified) (16 diffs)

orxonox/trunk/src/p_node.cc

@@ -45 +45 @@
 /**
    \brief constructor with coodinates
+   \param absCoordinate the Absolute coordinate of the Object
+   \param parent The parent-node of this node.
 */
 PNode::PNode (Vector* absCoordinate, PNode* parent )
@@ -111 +113 @@
 /**
    \brief set relative coordinates
-   \param relative coordinates to its parent
+   \param relCoord relative coordinates to its parent
 
    it is very importand, that you use this function, if you want to update the
@@ -135 +137 @@
 
 /**
-   \brief get relative coordinates
-   \returns relative coordinates to its parent
+   \param absCoord set absolute coordinate
 
    it is very importand, that you use this function, if you want to update the
@@ -196 +197 @@
 /**
    \brief set relative direction
-   \param relative direction to its parent
+   \param relDir to its parent
 
    it is very importand, that you use this function, if you want to update the
@@ -221 +222 @@
 /**
    \brief sets the absolute direction (0,0,1)
-   \param absolute coordinates
+   \param absDir absolute coordinates
 
    it is very importand, that you use this function, if you want to update the
@@ -253 +254 @@
    yea right... shorter...
 
+   \todo implement this
 */
 void PNode::shiftDir (Quaternion* shift)
@@ -261 +263 @@
 /**
    \brief adds a child and makes this node to a parent
-   \param child reference
+   \param pNode child reference
 
    use this to add a child to this node.
@@ -273 +275 @@
 /**
    \brief adds a child and makes this node to a parent
-   \param child reference
-   \param on which changes the child should also change ist state
+   \param pNode child reference
+   \param mode on which changes the child should also change ist state
 
    use this to add a child to this node.
@@ -287 +289 @@
 
 /**
-   /brief removes a child from the node
+   \brief removes a child from the node
+   \param pNode the child to remove from this pNode.
 */
 void PNode::removeChild (PNode* pNode)
@@ -297 +300 @@
 /**
    \brief sets the parent of this PNode
+   \param parent the Parent to set
 */
 void PNode::setParent (PNode* parent)
@@ -305 +309 @@
 /**
    \brief set the mode of this parent manualy
+   \param mode the mode of the bind-type.
 */
 void PNode::setMode (parentingMode mode)
@@ -337 +342 @@
 /**
    \brief updates the absCoordinate/absDirection
+   \param timeStamp The timestanp used for to look if calculations should be done
 
    this is used to go through the parent-tree to update all the absolute coordinates
@@ -400 +406 @@
 
 
-/*
+/**
   \brief tick
+  \param dt time to tick
 */
 void PNode::processTick (float dt)
@@ -414 +421 @@
 }
 
-
+/**
+   \param dt time to tick
+*/
 void PNode::tick (float dt)
 {}
 
-
+/**
+   \brief displays some information about this pNode
+*/
 void PNode::debug()
 {
@@ -428 +439 @@
 
 
-/*
+/**
   \brief set the name of the node
 
@@ -439 +450 @@
 
 
-/*
+/**
   \brief gets the name of the node
 */