Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/coord
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit
- Location:
- orxonox/trunk/src/lib/coord
- Files:
-
- 4 edited
-
null_parent.cc (modified) (3 diffs)
-
null_parent.h (modified) (1 diff)
-
p_node.cc (modified) (26 diffs)
-
p_node.h (modified) (5 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/coord/null_parent.cc
r4448 r4836 25 25 26 26 /** 27 \returns the Reference to the NullParent27 * @returns the Reference to the NullParent 28 28 */ 29 29 NullParent* NullParent::getInstance () … … 35 35 36 36 /** 37 \briefcreates the one and only NullParent38 \param absCoordinate the cordinate of the Parent (normally Vector(0,0,0))37 * creates the one and only NullParent 38 * @param absCoordinate the cordinate of the Parent (normally Vector(0,0,0)) 39 39 */ 40 40 NullParent::NullParent (const Vector& absCoordinate) : PNode (absCoordinate, NULL) … … 49 49 50 50 /** 51 \briefstandard deconstructor51 * standard deconstructor 52 52 */ 53 53 NullParent::~NullParent () -
orxonox/trunk/src/lib/coord/null_parent.h
r4448 r4836 1 1 /*! 2 2 \file null_parent.h 3 \briefDefinition of the NullParent, the higest PNode of them all.3 * Definition of the NullParent, the higest PNode of them all. 4 4 */ 5 5 -
orxonox/trunk/src/lib/coord/p_node.cc
r4785 r4836 15 15 co-programmer: 16 16 17 \todo Smooth-Parent: delay, speed17 @todo Smooth-Parent: delay, speed 18 18 */ 19 19 … … 40 40 41 41 /** 42 \briefstandard constructor42 * standard constructor 43 43 */ 44 44 PNode::PNode () … … 50 50 51 51 /** 52 \param root the load-Element for the PNode52 * @param root the load-Element for the PNode 53 53 */ 54 54 PNode::PNode(const TiXmlElement* root) … … 62 62 63 63 /** 64 \briefconstructor with coodinates65 \param absCoordinate the Absolute coordinate of the Object66 \param parent The parent-node of this node.64 * constructor with coodinates 65 * @param absCoordinate the Absolute coordinate of the Object 66 * @param parent The parent-node of this node. 67 67 */ 68 68 PNode::PNode (const Vector& absCoordinate, PNode* parent ) … … 80 80 81 81 /** 82 \briefstandard deconstructor82 * standard deconstructor 83 83 */ 84 84 PNode::~PNode () … … 98 98 99 99 /** 100 \briefinitializes a PNode101 \param parent the parent for this PNode100 * initializes a PNode 101 * @param parent the parent for this PNode 102 102 */ 103 103 void PNode::init(PNode* parent) … … 113 113 114 114 /** 115 \briefloads parameters of the PNode116 \param root the XML-element to load the properties of115 * loads parameters of the PNode 116 * @param root the XML-element to load the properties of 117 117 */ 118 118 void PNode::loadParams(const TiXmlElement* root) … … 153 153 154 154 /** 155 \briefset relative coordinates156 \param relCoord relative coordinates to its parent155 * set relative coordinates 156 * @param relCoord relative coordinates to its parent 157 157 158 158 it is very importand, that you use this function, if you want to update the … … 167 167 168 168 /** 169 \briefset relative coordinates170 \param x x-relative coordinates to its parent171 \param y y-relative coordinates to its parent172 \param z z-relative coordinates to its parent169 * set relative coordinates 170 * @param x x-relative coordinates to its parent 171 * @param y y-relative coordinates to its parent 172 * @param z z-relative coordinates to its parent 173 173 \see void PNode::setRelCoor (const Vector& relCoord) 174 174 */ … … 179 179 180 180 /** 181 \param absCoord set absolute coordinate181 * @param absCoord set absolute coordinate 182 182 183 183 it is very importand, that you use this function, if you want to update the … … 192 192 193 193 /** 194 * \param x x-coordinate.195 * \param y y-coordinate.196 * \param z z-coordinate.194 * @param x x-coordinate. 195 * @param y y-coordinate. 196 * @param z z-coordinate. 197 197 * \see void PNode::setAbsCoor (const Vector& absCoord) 198 198 */ … … 203 203 204 204 /** 205 \briefshift coordinate (abs and rel)206 \param shift shift vector205 * shift coordinate (abs and rel) 206 * @param shift shift vector 207 207 208 208 this function shifts the current coordinates about the vector shift. this is … … 237 237 238 238 /** 239 \briefset relative direction240 \param relDir to its parent239 * set relative direction 240 * @param relDir to its parent 241 241 242 242 it is very importand, that you use this function, if you want to update the … … 264 264 265 265 /** 266 \briefsets the absolute direction (0,0,1)267 \param absDir absolute coordinates266 * sets the absolute direction (0,0,1) 267 * @param absDir absolute coordinates 268 268 269 269 it is very importand, that you use this function, if you want to update the … … 291 291 292 292 /** 293 \briefshift coordinate (abs and rel)294 \param shift vector293 * shift coordinate (abs and rel) 294 * @param shift vector 295 295 296 296 this function shifts the current coordinates about the vector shift. this is … … 309 309 yea right... shorter... 310 310 311 \todo implement this311 @todo implement this 312 312 */ 313 313 void PNode::shiftDir (const Quaternion& shift) … … 318 318 319 319 /** 320 \briefadds a child and makes this node to a parent321 \param pNode child reference322 \param parentMode on which changes the child should also change ist state320 * adds a child and makes this node to a parent 321 * @param pNode child reference 322 * @param parentMode on which changes the child should also change ist state 323 323 324 324 use this to add a child to this node. … … 349 349 350 350 /** 351 \briefremoves a child from the node352 \param pNode the child to remove from this pNode.351 * removes a child from the node 352 * @param pNode the child to remove from this pNode. 353 353 354 354 Children from pNode will not be lost, they are referenced to NullPointer … … 363 363 364 364 /** 365 \briefremove this pnode from the tree and adds all following to NullParent365 * remove this pnode from the tree and adds all following to NullParent 366 366 367 367 this can be the case, if an entity in the world is been destroyed. … … 385 385 386 386 /** 387 \briefsets the parent of this PNode388 \param parent the Parent to set387 * sets the parent of this PNode 388 * @param parent the Parent to set 389 389 */ 390 390 void PNode::setParent (PNode* parent) … … 405 405 406 406 /** 407 \briefset the mode of this parent manualy408 \param parentMode the mode of the bind-type.407 * set the mode of this parent manualy 408 * @param parentMode the mode of the bind-type. 409 409 */ 410 410 void PNode::setParentMode (PARENT_MODE parentMode) … … 414 414 415 415 /** 416 * @briefsets the mode of this parent manually416 * sets the mode of this parent manually 417 417 * @param parentMode a String representing this parentingMode 418 418 */ … … 433 433 434 434 /** 435 \briefhas to be called, if the parent coordinate has changed435 * has to be called, if the parent coordinate has changed 436 436 437 437 normaly this will be done by the parent itself automaticaly. If you call this, you … … 446 446 447 447 /** 448 \briefupdates the absCoordinate/absDirection449 \param dt The time passed since the last update448 * updates the absCoordinate/absDirection 449 * @param dt The time passed since the last update 450 450 451 451 this is used to go through the parent-tree to update all the absolute coordinates … … 568 568 569 569 /** 570 \briefdisplays some information about this pNode571 \param depth The deph into which to debug the children of this PNode to.570 * displays some information about this pNode 571 * @param depth The deph into which to debug the children of this PNode to. 572 572 (0: all children will be debugged, 1: only this PNode, 2: this and direct children...) 573 \param level The n-th level of the Node we draw (this is internal and only for nice output)573 * @param level The n-th level of the Node we draw (this is internal and only for nice output) 574 574 */ 575 575 void PNode::debug(unsigned int depth, unsigned int level) const … … 608 608 609 609 /** 610 @briefdisplays the PNode at its position with its rotation as a cube.610 displays the PNode at its position with its rotation as a cube. 611 611 */ 612 612 void PNode::debugDraw(float size) const -
orxonox/trunk/src/lib/coord/p_node.h
r4771 r4836 1 1 /*! 2 2 \file p_node.h 3 \briefDefinition of a parenting node3 * Definition of a parenting node 4 4 5 5 parenting is how coordinates are handled in orxonox, meaning, that all coordinates … … 62 62 void setRelCoor (const Vector& relCoord); 63 63 void setRelCoor (float x, float y, float z); 64 /** \returns the relative position */64 /** @returns the relative position */ 65 65 inline const Vector& getRelCoor () const { return this->relCoordinate; }; 66 66 void setAbsCoor (const Vector& absCoord); 67 67 void setAbsCoor (float x, float y, float z); 68 /** \returns the absolute position */68 /** @returns the absolute position */ 69 69 inline const Vector& getAbsCoor () const { return this->absCoordinate; }; 70 70 void shiftCoor (const Vector& shift); … … 72 72 void setRelDir (const Quaternion& relDir); 73 73 void setRelDir (float x, float y, float z); 74 /** \returns the relative Direction */74 /** @returns the relative Direction */ 75 75 inline const Quaternion& getRelDir () const { return this->relDirection; }; 76 /** \returns a Vector pointing into the relative Direction */76 /** @returns a Vector pointing into the relative Direction */ 77 77 inline Vector getRelDirV() const { return this->relDirection.apply(Vector(0,1,0)); }; 78 78 void setAbsDir (const Quaternion& absDir); 79 79 void setAbsDir (float x, float y, float z); 80 /** \returns the absolute Direction */80 /** @returns the absolute Direction */ 81 81 inline const Quaternion& getAbsDir () const { return this->absDirection; }; 82 /** \returns a Vector pointing into the absolute Direction */82 /** @returns a Vector pointing into the absolute Direction */ 83 83 inline Vector getAbsDirV() const { return this->absDirection.apply(Vector(0,1,0)); }; 84 84 void shiftDir (const Quaternion& shift); 85 85 86 /** \returns the Speed of the Node */86 /** @returns the Speed of the Node */ 87 87 inline float getSpeed() const {return this->velocity.len();} 88 /** \returns the Velocity of the Node */88 /** @returns the Velocity of the Node */ 89 89 inline const Vector& getVelocity() const {return this->velocity;} 90 90 … … 100 100 void setParentMode (PARENT_MODE parentMode); 101 101 void setParentMode (const char* parentingMode); 102 /** \returns the Parenting mode of this node */102 /** @returns the Parenting mode of this node */ 103 103 int getParentMode() const { return this->parentMode; }; 104 104 … … 114 114 /** \brief tells the child that the parent's Direction has changed */ 115 115 inline void parentDirChanged () { this->bRelDirChanged = true; } 116 /** \returns the last calculated coordinate */116 /** @returns the last calculated coordinate */ 117 117 inline Vector getLastAbsCoor() {return this->lastAbsCoordinate;} 118 118
Note: See TracChangeset
for help on using the changeset viewer.
