Changeset 4448 in orxonox.OLD for orxonox/trunk/src/lib/coord/p_node.cc

Timestamp:

Jun 1, 2005, 10:55:53 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags, and cleanup of NullParent

File:

• orxonox/trunk/src/lib/coord/p_node.cc (modified) (15 diffs)

orxonox/trunk/src/lib/coord/p_node.cc

@@ -39 +39 @@
 /**
    \brief standard constructor
-
-   \todo this constructor is not jet implemented - do it
 */
 PNode::PNode () 
@@ -49 +47 @@
 }
 
+/**
+   \param root the load-Element for the PNode
+*/
 PNode::PNode(const TiXmlElement* root)
 {
@@ -94 +95 @@
 }
 
+/**
+   \brief initializes a PNode
+   \param parent the parent for this PNode
+*/
 void PNode::init(PNode* parent)
 {
@@ -104 +109 @@
 }
 
+/**
+   \brief loads parameters of the PNode
+   \param root the XML-element to load the properties of
+*/
 void PNode::loadParams(const TiXmlElement* root)
 {
   static_cast<BaseObject*>(this)->loadParams(root);
 }
-
-/**
-   \brief get relative coordinates
-   \returns relative coordinates to its parent
-   
-   the reference that is returned is a pointer to the real relCoor, so don't 
-   change it unless you realy know what you are doing.
-*/
-//Vector* PNode::getRelCoor () const
-
-
 
 /**
@@ -128 +126 @@
    has changed and won't update the children Nodes.
 */
-/*
-void PNode::setRelCoor (Vector* relCoord)
-{
-  this->bRelCoorChanged = true;
-  *this->relCoordinate = *relCoord;
-}
-*/
-
-
-/**
-   \brief set relative coordinates
-   \param relCoord relative coordinates to its parent
-
-   it is very importand, that you use this function, if you want to update the
-   relCoordinates. If you don't use this, the PNode won't recognize, that something
-   has changed and won't update the children Nodes.
-*/
 void PNode::setRelCoor (const Vector& relCoord)
 {
@@ -150 +131 @@
   this->relCoordinate = relCoord;
 }
-
-
-/**
-   \brief get absolute coordinates
-   \returns absolute coordinates from (0,0,0)
-*/
-//Vector PNode::getAbsCoor () const
-
-
-
-
 
 /**
@@ -175 +145 @@
 }
 
-
 /**
    \brief shift coordinate (abs and rel)
-   \param shift vector
+   \param shift shift vector
 
    this function shifts the current coordinates about the vector shift. this is
@@ -210 +179 @@
 }
 
-
-
-/**
-   \brief get relative direction
-   \returns relative direction to its parent
-*/
-//Quaternion* PNode::getRelDir () const
-
-
-
 /**
    \brief set relative direction
@@ -234 +193 @@
 }
 
-
-/**
-   \brief gets the absolute direction (0,0,1)
-   \returns absolute coordinates
-*/
-//Quaternion PNode::getAbsDir () const
-
-
-
 /**
    \brief sets the absolute direction (0,0,1)
@@ -256 +206 @@
   this->absDirection = absDir;
 }
-
-
 
 /**
@@ -289 +237 @@
    \brief adds a child and makes this node to a parent
    \param pNode child reference
-   \param mode on which changes the child should also change ist state
+   \param parentMode on which changes the child should also change ist state
 
    use this to add a child to this node.
@@ -304 +252 @@
   this->children->add(pNode);
 }
-
 
 /**
@@ -354 +301 @@
 /**
    \brief set the mode of this parent manualy
-   \param mode the mode of the bind-type.
+   \param parentMode the mode of the bind-type.
 */
 void PNode::setParentMode (unsigned int parentMode)
@@ -375 +322 @@
 */
 
-
-/**
-   \brief has to be called, if the parent direction has changed
-   
-   normaly this will be done by the parent itself automaticaly. If you call this, you
-   will force an update of the direction of the node.
-*/
-/*
-void PNode::parentDirChanged ()
-{
-  this->bRelDirChanged = true;
-}
-*/
-
-
 /**
    \brief updates the absCoordinate/absDirection
-   \param timeStamp The timestanp used for to look if calculations should be done
+   \param dt The time passed since the last update
 
    this is used to go through the parent-tree to update all the absolute coordinates
@@ -512 +444 @@
 }
 
-
-/**
-  \brief tick
-  \param dt time to tick
-*/
-void PNode::processTick (float dt)
-{
-  //this->tick (dt);
-  /*
-  PNode* pn = this->children->enumerate();
-  while( pn != NULL) 
-    { 
-      pn->processTick (dt);
-      pn = this->children->nextElement();
-    } 
-  */
-}
-
-
 /**
    \brief displays some information about this pNode