Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
- Location:
- orxonox/trunk/src/lib
- Files:
-
- 112 edited
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/collision_detection/bounding_sphere.cc
r4513 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 BoundingSphere::BoundingSphere () … … 31 31 32 32 /** 33 \briefstandard deconstructor33 * standard deconstructor 34 34 35 35 */ -
orxonox/trunk/src/lib/collision_detection/bounding_sphere.h
r4525 r4836 1 1 /*! 2 2 \file bounding_sphere.h 3 \briefDefinition of a bounding sphere3 * Definition of a bounding sphere 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/bounding_volume.cc
r4814 r4836 23 23 24 24 /** 25 \briefstandard constructor25 * standard constructor 26 26 */ 27 27 BoundingVolume::BoundingVolume () … … 34 34 35 35 /** 36 \briefstandard deconstructor36 * standard deconstructor 37 37 38 38 */ -
orxonox/trunk/src/lib/collision_detection/bounding_volume.h
r4814 r4836 1 1 /*! 2 2 \file bounding_volume.h 3 \briefDefinition of a bounding volume for collision detection algorithms3 * Definition of a bounding volume for collision detection algorithms 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/bv_tree.cc
r4528 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 BVTree::BVTree () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ -
orxonox/trunk/src/lib/collision_detection/bv_tree.h
r4712 r4836 1 1 /*! 2 2 \file bv_tree.h 3 \briefDefinition of a bounding volume tree3 * Definition of a bounding volume tree 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/bv_tree_node.cc
r4814 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 BVTreeNode::BVTreeNode () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ -
orxonox/trunk/src/lib/collision_detection/bv_tree_node.h
r4702 r4836 1 1 /*! 2 2 \file bv_tree.h 3 \briefDefinition of a bounding volume tree3 * Definition of a bounding volume tree 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/cd_engine.cc
r4742 r4836 27 27 28 28 /** 29 \briefstandard constructor29 * standard constructor 30 30 */ 31 31 CDEngine::CDEngine () … … 38 38 39 39 /** 40 \briefthe singleton reference to this class40 * the singleton reference to this class 41 41 */ 42 42 CDEngine* CDEngine::singletonRef = NULL; 43 43 44 44 /** 45 \briefstandard deconstructor45 * standard deconstructor 46 46 47 47 */ -
orxonox/trunk/src/lib/collision_detection/cd_engine.h
r4746 r4836 1 1 /*! 2 2 \file cd_engine.h 3 \briefDefinition of the collision detection engine3 * Definition of the collision detection engine 4 4 5 5 */ … … 35 35 public: 36 36 virtual ~CDEngine(); 37 /** \returns a Pointer to the only object of this Class */37 /** @returns a Pointer to the only object of this Class */ 38 38 static CDEngine* getInstance() { if (!singletonRef) singletonRef = new CDEngine(); return singletonRef; } 39 39 void init(); -
orxonox/trunk/src/lib/collision_detection/collision.cc
r4511 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 Collision::Collision () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ -
orxonox/trunk/src/lib/collision_detection/collision.h
r4544 r4836 1 1 /*! 2 2 \file collision.h 3 \briefDefinition of a collision event3 * Definition of a collision event 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/collision_defs.h
r4520 r4836 1 1 /*! 2 2 \file collision_defs.h 3 \briefDefinition of some global collision data3 * Definition of some global collision data 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/lin_alg.h
r4746 r4836 1 1 /*! 2 2 \file lin_alg.h 3 \briefDefinition of some important linear algebra formulas3 * Definition of some important linear algebra formulas 4 4 5 5 compute the eigenpairs (eigenvalues and eigenvectors) of a real symmetric matrix "A" by the Jacobi method -
orxonox/trunk/src/lib/collision_detection/obb.cc
r4815 r4836 24 24 25 25 /** 26 \briefstandard constructor26 * standard constructor 27 27 */ 28 28 OBB::OBB () … … 37 37 38 38 /** 39 \briefstandard deconstructor39 * standard deconstructor 40 40 41 41 */ -
orxonox/trunk/src/lib/collision_detection/obb.h
r4814 r4836 1 1 /*! 2 2 \file obb.h 3 \briefDefinition of an OBB (object Oriented Bounding Box)3 * Definition of an OBB (object Oriented Bounding Box) 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/obb_tree.cc
r4814 r4836 28 28 29 29 /** 30 \briefstandard constructor30 * standard constructor 31 31 */ 32 32 OBBTree::OBBTree () … … 82 82 83 83 /** 84 \briefstandard deconstructor84 * standard deconstructor 85 85 86 86 */ -
orxonox/trunk/src/lib/collision_detection/obb_tree.h
r4702 r4836 1 1 /*! 2 2 \file obb_tree.h 3 \briefDefinition of an obb tree (object oriented Bounding Box)3 * Definition of an obb tree (object oriented Bounding Box) 4 4 5 5 */ -
orxonox/trunk/src/lib/collision_detection/obb_tree_node.cc
r4815 r4836 43 43 44 44 /** 45 \briefstandard constructor45 * standard constructor 46 46 */ 47 47 OBBTreeNode::OBBTreeNode () … … 76 76 77 77 /** 78 \briefstandard deconstructor78 * standard deconstructor 79 79 */ 80 80 OBBTreeNode::~OBBTreeNode () … … 98 98 99 99 /** 100 \briefcreates a new BVTree or BVTree partition101 \param depth: how much more depth-steps to go: if == 1 don't go any deeper!102 \param verticesList: the list of vertices of the object - each vertices triple is interpreted as a triangle100 * creates a new BVTree or BVTree partition 101 * @param depth: how much more depth-steps to go: if == 1 don't go any deeper! 102 * @param verticesList: the list of vertices of the object - each vertices triple is interpreted as a triangle 103 103 */ 104 104 void OBBTreeNode::spawnBVTree(const int depth, sVec3D *verticesList, const int length) … … 494 494 /** 495 495 \brief this separates an ob-box in the middle 496 \param box: the box to separate496 * @param box: the box to separate 497 497 498 498 this will separate the box into to smaller boxes. the separation is done along the middle of the longest axis -
orxonox/trunk/src/lib/collision_detection/obb_tree_node.h
r4746 r4836 1 1 /*! 2 2 \file bv_tree.h 3 \briefDefinition of a bounding volume tree3 * Definition of a bounding volume tree 4 4 5 5 */ … … 60 60 static OBBTree* obbTree; //!< reference to the obb tree 61 61 Plane* separationPlane; //!< the separation plane of the obb 62 sVec3D* sepPlaneCenter; //!< only needed to draw plane \todo: separationPlane drawing62 sVec3D* sepPlaneCenter; //!< only needed to draw plane @todo: separationPlane drawing 63 63 int longestAxisIndex; //!< only needed to draw plane 64 64 -
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 -
orxonox/trunk/src/lib/event/event.cc
r4457 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 Event::Event () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ -
orxonox/trunk/src/lib/event/event.h
r4782 r4836 1 1 /*! 2 2 \file event.h 3 \briefan abstract event3 * an abstract event 4 4 5 5 */ -
orxonox/trunk/src/lib/event/event_def.h
r4782 r4836 1 1 /*! 2 2 \file event_def.h 3 \briefsome central definitions3 * some central definitions 4 4 5 5 */ -
orxonox/trunk/src/lib/event/event_handler.cc
r4817 r4836 29 29 30 30 /** 31 \briefstandard constructor31 * standard constructor 32 32 */ 33 33 EventHandler::EventHandler () … … 52 52 53 53 /** 54 \briefthe singleton reference to this class54 * the singleton reference to this class 55 55 */ 56 56 EventHandler* EventHandler::singletonRef = NULL; … … 58 58 59 59 /** 60 \briefstandard deconstructor60 * standard deconstructor 61 61 62 62 */ … … 80 80 81 81 /** 82 \briefinitializes the event handler82 * initializes the event handler 83 83 84 84 this has to be called before the use of the event handler … … 92 92 93 93 /** 94 \briefset the state of the event handler95 \param state: to which the event handler shall change94 * set the state of the event handler 95 * @param state: to which the event handler shall change 96 96 */ 97 97 void EventHandler::setState(elState state) … … 102 102 103 103 /** 104 \briefsubscribe to an event105 \param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures106 \param state: for which the listener wants to receive events107 \param eventType: the event type that wants to be listened for.104 * subscribe to an event 105 * @param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures 106 * @param state: for which the listener wants to receive events 107 * @param eventType: the event type that wants to be listened for. 108 108 109 109 This is one of the most important function of the EventHandler. If you would like to subscribe for more … … 111 111 state = ES_ALL, which will subscribe your listener for all states together. 112 112 * 113 * \todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL113 * @todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL 114 114 */ 115 115 void EventHandler::subscribe(EventListener* el, elState state, int eventType) … … 135 135 136 136 /** 137 \briefunsubscribe from the EventHandler138 \param state: the stat in which it has been subscribed139 \param eventType: the event, that shall be unsubscribed137 * unsubscribe from the EventHandler 138 * @param state: the stat in which it has been subscribed 139 * @param eventType: the event, that shall be unsubscribed 140 140 141 141 if you want to unsubscribe an event listener from all subscribed events, just use the … … 150 150 151 151 /** 152 \briefunsubscribe all events from a specific listener153 \param el: the listener that wants to unsubscribe itself154 \param state: the state in which the events shall be unsubscribed152 * unsubscribe all events from a specific listener 153 * @param el: the listener that wants to unsubscribe itself 154 * @param state: the state in which the events shall be unsubscribed 155 155 156 156 */ … … 182 182 183 183 /** 184 \briefflush all registered events185 \param state: a specific state184 * flush all registered events 185 * @param state: a specific state 186 186 */ 187 187 void EventHandler::flush(elState state) … … 208 208 209 209 /** 210 \briefcore function of event handler: receives all events from SDL210 * core function of event handler: receives all events from SDL 211 211 212 212 The event from the SDL framework are collected here and distributed to all listeners. -
orxonox/trunk/src/lib/event/event_handler.h
r4834 r4836 1 1 /*! 2 2 \file event_handler.h 3 \briefDefinition of the EventHandler3 * Definition of the EventHandler 4 4 5 5 */ … … 21 21 public: 22 22 virtual ~EventHandler(); 23 /** \returns a Pointer to the only object of this Class */23 /** @returns a Pointer to the only object of this Class */ 24 24 inline static EventHandler* getInstance() { if (!singletonRef) singletonRef = new EventHandler(); return singletonRef; }; 25 25 void init(); -
orxonox/trunk/src/lib/event/event_listener.cc
r4817 r4836 23 23 24 24 /** 25 \briefstandard constructor25 * standard constructor 26 26 */ 27 27 EventListener::EventListener () 28 28 { 29 29 this->setClassID(CL_EVENT_LISTENER, "EventListener"); 30 30 } 31 31 32 32 33 33 /** 34 \brief standard deconstructor 35 34 * standard deconstructor 36 35 */ 37 36 EventListener::~EventListener () -
orxonox/trunk/src/lib/event/event_listener.h
r4457 r4836 1 1 /*! 2 2 \file event_listener.h 3 \briefDefinition of an event listener base class3 * Definition of an event listener base class 4 4 5 5 */ … … 21 21 22 22 /** 23 \briefabstract function that processes events from the handler24 \param event: the event23 * abstract function that processes events from the handler 24 * @param event: the event 25 25 */ 26 26 virtual void process(const Event &event) = NULL; -
orxonox/trunk/src/lib/event/key_mapper.cc
r4834 r4836 92 92 93 93 /** 94 \briefstandard constructor94 * standard constructor 95 95 */ 96 96 KeyMapper::KeyMapper () … … 101 101 102 102 /** 103 \briefstandard deconstructor103 * standard deconstructor 104 104 */ 105 105 KeyMapper::~KeyMapper () … … 109 109 110 110 /** 111 \briefloads new key bindings from a file112 \param filename: The path and name of the file to load the bindings from111 * loads new key bindings from a file 112 * @param filename: The path and name of the file to load the bindings from 113 113 */ 114 114 void KeyMapper::loadKeyBindings (const char* fileName) … … 189 189 190 190 /** 191 \briefthis function looks up name to key index192 \param the name of the button191 * this function looks up name to key index 192 * @param the name of the button 193 193 */ 194 194 int* KeyMapper::nameToIndex (char* name) … … 212 212 213 213 /** 214 \briefthe function maps name to key ids215 \param name of the key216 \param id of the key214 * the function maps name to key ids 215 * @param name of the key 216 * @param id of the key 217 217 */ 218 218 void KeyMapper::mapKeys(char* name, int keyID) … … 231 231 232 232 /** 233 \briefthis function gives some debug information about the key mapper class233 * this function gives some debug information about the key mapper class 234 234 */ 235 235 void KeyMapper::debug() -
orxonox/trunk/src/lib/event/key_mapper.h
r4457 r4836 1 1 /*! 2 2 \file key_mapper.h 3 \briefa construct to map player defined keys to SDL keys3 * a construct to map player defined keys to SDL keys 4 4 5 5 */ -
orxonox/trunk/src/lib/event/key_names.h
r4780 r4836 1 1 /*! 2 2 \file keynames.h 3 \briefKey/button naming functions3 * Key/button naming functions 4 4 5 5 Converts strings to SDLK/SDL_BUTTON values and vice versa … … 9 9 10 10 /** 11 \briefconverts a button name string to a integer representing the corresponding SDL mouse button identifier12 \param name: the name of the mouse button13 \return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid11 * converts a button name string to a integer representing the corresponding SDL mouse button identifier 12 * @param name: the name of the mouse button 13 * @return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid 14 14 */ 15 15 int buttonnameToSDLB(const char* name); 16 16 17 17 /** 18 \briefconverst a SDL mouse button identifier to a name string19 \param button: an SDL mouse button identifier20 \return a pointer to a string containing the name of the mouse button18 * converst a SDL mouse button identifier to a name string 19 * @param button: an SDL mouse button identifier 20 * @return a pointer to a string containing the name of the mouse button 21 21 */ 22 22 char* SDLBToButtonname( int button); 23 23 24 24 /** 25 \briefconverts a key name string to a integer representing the corresponding SDLK sym26 \param name: the name of the key27 \return the SDLK sym of the named key or -1 if the key name is not valid25 * converts a key name string to a integer representing the corresponding SDLK sym 26 * @param name: the name of the key 27 * @return the SDLK sym of the named key or -1 if the key name is not valid 28 28 */ 29 29 int keynameToSDLK(const char* name); 30 30 31 31 /** 32 \briefconverts an SDLK sym to a name string33 \param key: the SDLK sym34 \return a pointer to a string containig the name of the key32 * converts an SDLK sym to a name string 33 * @param key: the SDLK sym 34 * @return a pointer to a string containig the name of the key 35 35 */ 36 36 char* SDLKToKeyname( int key); -
orxonox/trunk/src/lib/graphics/graphics_engine.cc
r4835 r4836 30 30 31 31 /** 32 \briefstandard constructor33 \todo this constructor is not jet implemented - do it32 * standard constructor 33 @todo this constructor is not jet implemented - do it 34 34 */ 35 35 GraphicsEngine::GraphicsEngine () … … 48 48 49 49 /** 50 \briefThe Pointer to this GraphicsEngine50 * The Pointer to this GraphicsEngine 51 51 */ 52 52 GraphicsEngine* GraphicsEngine::singletonRef = NULL; 53 53 54 54 /** 55 \briefdestructs the graphicsEngine.55 * destructs the graphicsEngine. 56 56 */ 57 57 GraphicsEngine::~GraphicsEngine () … … 103 103 104 104 /** 105 \briefinitializes the Video for openGL.105 * initializes the Video for openGL. 106 106 107 107 This has to be done only once when starting orxonox. … … 170 170 171 171 /** 172 \briefSets the GL-attributes172 * Sets the GL-attributes 173 173 */ 174 174 int GraphicsEngine::setGLattribs() … … 192 192 193 193 /** 194 \briefsets the Resolution of the Screen to display the Graphics to.195 \param width The width of the window196 \param height The height of the window197 \param bpp bits per pixel194 * sets the Resolution of the Screen to display the Graphics to. 195 * @param width The width of the window 196 * @param height The height of the window 197 * @param bpp bits per pixel 198 198 */ 199 199 int GraphicsEngine::setResolution(int width, int height, int bpp) … … 212 212 213 213 /** 214 \briefsets Fullscreen mode215 \param fullscreen true if fullscreen, false if windowed214 * sets Fullscreen mode 215 * @param fullscreen true if fullscreen, false if windowed 216 216 */ 217 217 void GraphicsEngine::setFullscreen(bool fullscreen) … … 225 225 226 226 /** 227 \briefsets the background color228 \param red the red part of the background229 \param blue the blue part of the background230 \param green the green part of the background231 \param alpha the alpha part of the background227 * sets the background color 228 * @param red the red part of the background 229 * @param blue the blue part of the background 230 * @param green the green part of the background 231 * @param alpha the alpha part of the background 232 232 */ 233 233 void GraphicsEngine::setBackgroundColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha) … … 238 238 239 239 /** 240 \briefSignalhandler, for when the resolution has changed241 \param resizeInfo SDL information about the size of the new screen size240 * Signalhandler, for when the resolution has changed 241 * @param resizeInfo SDL information about the size of the new screen size 242 242 */ 243 243 int GraphicsEngine::resolutionChanged(const SDL_ResizeEvent& resizeInfo) … … 308 308 309 309 /** 310 \briefentering 2D Mode310 * entering 2D Mode 311 311 312 312 this is a GL-Projection-mode, that is orthogonal, for placing the font in fron of everything else … … 341 341 342 342 /** 343 \briefleaves the 2DMode again also \see Font::enter2DMode()343 * leaves the 2DMode again also \see Font::enter2DMode() 344 344 */ 345 345 void GraphicsEngine::leave2DMode() … … 355 355 356 356 /** 357 \briefstores the GL_matrices357 * stores the GL_matrices 358 358 */ 359 359 void GraphicsEngine::storeMatrices() … … 374 374 375 375 /** 376 \briefoutputs all the Fullscreen modes.376 * outputs all the Fullscreen modes. 377 377 */ 378 378 void GraphicsEngine::listModes() … … 400 400 401 401 /** 402 \briefticks the Text403 \param dt the time passed402 * ticks the Text 403 * @param dt the time passed 404 404 */ 405 405 void GraphicsEngine::tick(float dt) … … 426 426 427 427 /** 428 \briefdisplays the Frames per second429 \param display if the text should be displayed430 431 \todo this is dangerous428 * displays the Frames per second 429 * @param display if the text should be displayed 430 431 @todo this is dangerous 432 432 */ 433 433 void GraphicsEngine::displayFPS(bool display) … … 453 453 /** 454 454 \brief processes the events for orxonox main class 455 \param the event to handle455 * @param the event to handle 456 456 */ 457 457 void GraphicsEngine::process(const Event &event) -
orxonox/trunk/src/lib/graphics/graphics_engine.h
r4834 r4836 2 2 \file graphics_engine.h 3 3 4 \briefdefines a Interface between orxonox and graphical input4 * defines a Interface between orxonox and graphical input 5 5 6 6 handles graphical SDL-initialisation, textures, resolutions, and so on … … 27 27 public: 28 28 virtual ~GraphicsEngine(); 29 /** \returns a Pointer to the only object of this Class */29 /** @returns a Pointer to the only object of this Class */ 30 30 inline static GraphicsEngine* getInstance() { if (!singletonRef) singletonRef = new GraphicsEngine(); return singletonRef; }; 31 31 … … 40 40 41 41 42 /** \returns the x resolution */42 /** @returns the x resolution */ 43 43 inline int getResolutionX() const { return this->resolutionX; }; 44 /** \returns the y resolution */44 /** @returns the y resolution */ 45 45 inline int getResolutionY() const { return this->resolutionY; }; 46 /** \returns the Bits Per Pixel */46 /** @returns the Bits Per Pixel */ 47 47 inline int getbbp() const { return this->bitsPerPixel; }; 48 48 -
orxonox/trunk/src/lib/graphics/importer/abstract_model.h
r4809 r4836 16 16 /*! 17 17 \file abstract_model.h 18 \briefDefinition of an abstract model. containing all needed for other model18 * Definition of an abstract model. containing all needed for other model 19 19 */ 20 20 -
orxonox/trunk/src/lib/graphics/importer/array.h
r4799 r4836 36 36 void addEntry(T entry0, T entry1, T entry2); 37 37 38 /** \returns The array */38 /** @returns The array */ 39 39 inline const T* getArray () const { return this->array; }; 40 /** \returns The Count of entries in the Array*/40 /** * @returns The Count of entries in the Array*/ 41 41 inline unsigned int getCount()const { return this->entryCount; }; 42 42 inline int getIndex(T* entry) const; … … 61 61 62 62 /** 63 \briefcreates a new Array63 * creates a new Array 64 64 */ 65 65 template<class T> … … 75 75 76 76 /** 77 \briefdeletes an Array.77 * deletes an Array. 78 78 It does this by first deleting all the array-entries, and then delete the array[] itself 79 79 */ … … 95 95 96 96 /** 97 \brieffinalizes an array.97 * finalizes an array. 98 98 This Function creates the array, and makes it ready to be sent to the application. 99 99 */ … … 124 124 125 125 /** 126 \briefadds a new Entry to the Array127 \param entry Entry to add.126 * adds a new Entry to the Array 127 * @param entry Entry to add. 128 128 */ 129 129 template<class T> … … 145 145 146 146 /** 147 \briefAdds 3 entries at once (convenience)147 * Adds 3 entries at once (convenience) 148 148 */ 149 149 template<class T> … … 157 157 158 158 /** 159 \briefgets back the index of the entry in the array. value check160 \param entry: the entry to look up161 \returns the index in the array, -1 if not found159 * gets back the index of the entry in the array. value check 160 * @param entry: the entry to look up 161 * @returns the index in the array, -1 if not found 162 162 */ 163 163 template<class T> … … 176 176 177 177 /** 178 \briefSimple debug info about the Array178 * Simple debug info about the Array 179 179 */ 180 180 template<class T> -
orxonox/trunk/src/lib/graphics/importer/material.cc
r4834 r4836 25 25 #include <string.h> 26 26 27 //! \todo check if we are in RESOURCE MANAGER-mode27 //! @todo check if we are in RESOURCE MANAGER-mode 28 28 #include "resource_manager.h" 29 29 … … 31 31 32 32 /** 33 \briefcreates a Material.34 \param mtlName Name of the Material to be added to the Material List33 * creates a Material. 34 * @param mtlName Name of the Material to be added to the Material List 35 35 */ 36 36 Material::Material (const char* mtlName) … … 52 52 53 53 /** 54 \briefdeletes a Material54 * deletes a Material 55 55 */ 56 56 Material::~Material() … … 67 67 68 68 /** 69 \briefsets the material with which the following Faces will be painted69 * sets the material with which the following Faces will be painted 70 70 */ 71 71 bool Material::select () … … 99 99 100 100 // setting illumination Model 101 if (this->illumModel == 1) //! \todo make this work, if no vertex-normals are read.101 if (this->illumModel == 1) //! @todo make this work, if no vertex-normals are read. 102 102 glShadeModel(GL_FLAT); 103 103 else if (this->illumModel >= 2) … … 124 124 125 125 /** 126 \briefSets the Material Illumination Model.127 \briefillu illumination Model in int form126 * Sets the Material Illumination Model. 127 * illu illumination Model in int form 128 128 */ 129 129 void Material::setIllum (int illum) … … 133 133 } 134 134 /** 135 \briefSets the Material Illumination Model.136 \briefillu illumination Model in char* form135 * Sets the Material Illumination Model. 136 * illu illumination Model in char* form 137 137 */void Material::setIllum (char* illum) 138 138 { … … 141 141 142 142 /** 143 \briefSets the Material Diffuse Color.144 \param r Red Color Channel.145 \param g Green Color Channel.146 \param b Blue Color Channel.143 * Sets the Material Diffuse Color. 144 * @param r Red Color Channel. 145 * @param g Green Color Channel. 146 * @param b Blue Color Channel. 147 147 */ 148 148 void Material::setDiffuse (float r, float g, float b) … … 156 156 } 157 157 /** 158 \briefSets the Material Diffuse Color.159 \param rgb The red, green, blue channel in char format (with spaces between them)158 * Sets the Material Diffuse Color. 159 * @param rgb The red, green, blue channel in char format (with spaces between them) 160 160 */ 161 161 void Material::setDiffuse (char* rgb) … … 167 167 168 168 /** 169 \briefSets the Material Ambient Color.170 \param r Red Color Channel.171 \param g Green Color Channel.172 \param b Blue Color Channel.169 * Sets the Material Ambient Color. 170 * @param r Red Color Channel. 171 * @param g Green Color Channel. 172 * @param b Blue Color Channel. 173 173 */ 174 174 void Material::setAmbient (float r, float g, float b) … … 181 181 } 182 182 /** 183 \briefSets the Material Ambient Color.184 \param rgb The red, green, blue channel in char format (with spaces between them)183 * Sets the Material Ambient Color. 184 * @param rgb The red, green, blue channel in char format (with spaces between them) 185 185 */ 186 186 void Material::setAmbient (char* rgb) … … 192 192 193 193 /** 194 \briefSets the Material Specular Color.195 \param r Red Color Channel.196 \param g Green Color Channel.197 \param b Blue Color Channel.194 * Sets the Material Specular Color. 195 * @param r Red Color Channel. 196 * @param g Green Color Channel. 197 * @param b Blue Color Channel. 198 198 */ 199 199 void Material::setSpecular (float r, float g, float b) … … 206 206 } 207 207 /** 208 \briefSets the Material Specular Color.209 \param rgb The red, green, blue channel in char format (with spaces between them)208 * Sets the Material Specular Color. 209 * @param rgb The red, green, blue channel in char format (with spaces between them) 210 210 */ 211 211 void Material::setSpecular (char* rgb) … … 217 217 218 218 /** 219 \briefSets the Material Shininess.220 \param shini stes the Shininess from float.219 * Sets the Material Shininess. 220 * @param shini stes the Shininess from float. 221 221 */ 222 222 void Material::setShininess (float shini) … … 225 225 } 226 226 /** 227 \briefSets the Material Shininess.228 \param shini stes the Shininess from char*.227 * Sets the Material Shininess. 228 * @param shini stes the Shininess from char*. 229 229 */ 230 230 void Material::setShininess (char* shini) … … 234 234 235 235 /** 236 \briefSets the Material Transparency.237 \param trans stes the Transparency from int.236 * Sets the Material Transparency. 237 * @param trans stes the Transparency from int. 238 238 */ 239 239 void Material::setTransparency (float trans) … … 243 243 } 244 244 /** 245 \briefSets the Material Transparency.246 \param trans stes the Transparency from char*.245 * Sets the Material Transparency. 246 * @param trans stes the Transparency from char*. 247 247 */ 248 248 void Material::setTransparency (char* trans) … … 252 252 253 253 /** 254 \briefAdds a Texture Path to the List of already existing Paths255 \param pathName The Path to add.254 * Adds a Texture Path to the List of already existing Paths 255 * @param pathName The Path to add. 256 256 */ 257 257 void Material::addTexturePath(const char* pathName) … … 263 263 264 264 /** 265 \briefSets the Materials Diffuse Map266 \param dMap the Name of the Image to Use265 * Sets the Materials Diffuse Map 266 * @param dMap the Name of the Image to Use 267 267 */ 268 268 void Material::setDiffuseMap(const char* dMap) … … 281 281 282 282 /** 283 \briefSets the Materials Ambient Map284 \param aMap the Name of the Image to Use285 \todo implement this283 * Sets the Materials Ambient Map 284 * @param aMap the Name of the Image to Use 285 @todo implement this 286 286 */ 287 287 void Material::setAmbientMap(const char* aMap) … … 292 292 293 293 /** 294 \briefSets the Materials Specular Map295 \param sMap the Name of the Image to Use296 \todo implement this294 * Sets the Materials Specular Map 295 * @param sMap the Name of the Image to Use 296 @todo implement this 297 297 */ 298 298 void Material::setSpecularMap(const char* sMap) … … 303 303 304 304 /** 305 \briefSets the Materials Bumpiness306 \param bump the Name of the Image to Use307 \todo implemet this305 * Sets the Materials Bumpiness 306 * @param bump the Name of the Image to Use 307 @todo implemet this 308 308 */ 309 309 void Material::setBump(const char* bump) -
orxonox/trunk/src/lib/graphics/importer/material.h
r4746 r4836 2 2 \file material.h 3 3 \brief Contains the Material Class that handles Material for 3D-Objects. 4 \todo free SDL-surface when deleting Material.5 \todo delete imgNameWithPath after use creation.4 @todo free SDL-surface when deleting Material. 5 @todo delete imgNameWithPath after use creation. 6 6 */ 7 7 -
orxonox/trunk/src/lib/graphics/importer/md2Model.cc
r4787 r4836 101 101 102 102 /** 103 \briefinitializes an array of vert with the current frame scaled vertices104 \param verticesList: the list of vertices to interpolate between103 * initializes an array of vert with the current frame scaled vertices 104 * @param verticesList: the list of vertices to interpolate between 105 105 106 106 we won't use the pVertices array directly, since its much easier and we need … … 126 126 /** 127 127 \brief sets the animation type 128 \param type: animation type128 * @param type: animation type 129 129 130 130 the animation types can be looked up in the animationType table … … 150 150 /** 151 151 \brief sets the time in seconds passed since the last tick 152 \param time: in sec152 * @param time: in sec 153 153 */ 154 154 void MD2Model::tick(float time) … … 320 320 /** 321 321 \brief this will load the whole model data (vertices, opengl command list, ...) 322 \param fileName: the name of the model file322 * @param fileName: the name of the model file 323 323 \return true if success 324 324 */ … … 418 418 /** 419 419 \brief loads the skin/material stuff 420 \param fileName: name of the skin file420 * @param fileName: name of the skin file 421 421 \return true if success 422 422 */ -
orxonox/trunk/src/lib/graphics/importer/md2Model.h
r4787 r4836 1 1 /*! 2 2 \file md2Model.h 3 \briefDefinition of an MD2 Model, a model format invented by ID Software.3 * Definition of an MD2 Model, a model format invented by ID Software. 4 4 5 5 We are deeply thankfull for all the wunderfull things id software made for us gamers! … … 142 142 void setAnim(int type); 143 143 /** 144 \briefscales the current model145 \param scaleFactor: the factor [0..1] to use for scaling144 * scales the current model 145 * @param scaleFactor: the factor [0..1] to use for scaling 146 146 */ 147 147 void scaleModel(float scaleFactor) { this->scaleFactor = scaleFactor;} -
orxonox/trunk/src/lib/graphics/importer/model.cc
r4834 r4836 33 33 //////////////////// 34 34 /** 35 \briefcreates a new ModelFaceElement35 * creates a new ModelFaceElement 36 36 */ 37 37 ModelFaceElement::ModelFaceElement() … … 45 45 46 46 /** 47 \briefdestroys a ModelFaceElement47 * destroys a ModelFaceElement 48 48 */ 49 49 ModelFaceElement::~ModelFaceElement() … … 54 54 55 55 /** 56 \briefcreates a new ModelFace56 * creates a new ModelFace 57 57 */ 58 58 ModelFace::ModelFace() … … 69 69 70 70 /** 71 \briefdeletes a ModelFace71 * deletes a ModelFace 72 72 */ 73 73 ModelFace::~ModelFace() … … 83 83 84 84 /** 85 \briefCreates a new ModelGroup85 * Creates a new ModelGroup 86 86 */ 87 87 ModelGroup::ModelGroup() … … 98 98 99 99 /** 100 \briefdeletes a ModelGroup100 * deletes a ModelGroup 101 101 */ 102 102 ModelGroup::~ModelGroup() … … 111 111 112 112 /** 113 \briefcleans up a ModelGroup113 * cleans up a ModelGroup 114 114 115 115 actually does the same as the delete Operator, but does not delete the predecessing group … … 130 130 ///////////// 131 131 /** 132 \briefCreates a 3D-Model.132 * Creates a 3D-Model. 133 133 134 134 assigns it a Name and a Type … … 166 166 167 167 /** 168 \briefdeletes an Model.168 * deletes an Model. 169 169 170 170 Looks if any from model allocated space is still in use, and if so deleted it. … … 206 206 207 207 /** 208 \briefFinalizes an Object. This can be done outside of the Class.208 * Finalizes an Object. This can be done outside of the Class. 209 209 */ 210 210 void Model::finalize() … … 237 237 ////////// 238 238 /** 239 \briefDraws the Models of all Groups.239 * Draws the Models of all Groups. 240 240 It does this by just calling the Lists that must have been created earlier. 241 241 */ … … 280 280 281 281 /** 282 \briefDraws the Model number groupNumber283 \param groupNumber The number of the group that will be displayed.282 * Draws the Model number groupNumber 283 * @param groupNumber The number of the group that will be displayed. 284 284 285 285 It does this by just calling the List that must have been created earlier. … … 312 312 313 313 /** 314 \briefDraws the Model with a specific groupName315 \param groupName The name of the group that will be displayed.314 * Draws the Model with a specific groupName 315 * @param groupName The name of the group that will be displayed. 316 316 317 317 It does this by just calling the List that must have been created earlier. … … 339 339 ////////// 340 340 /** 341 \briefdeletes all the arrays341 * deletes all the arrays 342 342 */ 343 343 bool Model::deleteArrays() … … 359 359 360 360 /** 361 \brieffinalizes an Model.361 * finalizes an Model. 362 362 * This funcion is needed, to delete all the Lists, and arrays that are no more 363 363 * needed because they are already imported into openGL. … … 375 375 ////////// 376 376 /** 377 \briefadds a new Material to the Material List378 \param material the Material to add379 \returns the added material377 * adds a new Material to the Material List 378 * @param material the Material to add 379 * @returns the added material 380 380 * 381 381 * this also tells this Model, that all the Materials are handled externally … … 391 391 392 392 /** 393 \briefadds a new Material to the Material List394 \param materialName the name of the Material to add395 \returns the added material393 * adds a new Material to the Material List 394 * @param materialName the name of the Material to add 395 * @returns the added material 396 396 */ 397 397 Material* Model::addMaterial(const char* materialName) … … 406 406 407 407 /** 408 \brieffinds a Material by its name and returns it409 \param materialName the Name of the material to search for.410 \returns the Material if found, NULL otherwise408 * finds a Material by its name and returns it 409 * @param materialName the Name of the material to search for. 410 * @returns the Material if found, NULL otherwise 411 411 */ 412 412 Material* Model::findMaterialByName(const char* materialName) … … 428 428 429 429 /** 430 \briefparses a group String431 \param groupString the new Group to create430 * parses a group String 431 * @param groupString the new Group to create 432 432 433 433 This function initializes a new Group. … … 452 452 453 453 /** 454 \briefparses a vertex-String455 \param vertexString The String that will be parsed.454 * parses a vertex-String 455 * @param vertexString The String that will be parsed. 456 456 457 457 If a vertex line is found this function will inject it into the vertex-Array … … 470 470 471 471 /** 472 \briefparses a vertex-String473 \param x the X-coordinate of the Vertex to add.474 \param y the Y-coordinate of the Vertex to add.475 \param z the Z-coordinate of the Vertex to add.472 * parses a vertex-String 473 * @param x the X-coordinate of the Vertex to add. 474 * @param y the Y-coordinate of the Vertex to add. 475 * @param z the Z-coordinate of the Vertex to add. 476 476 477 477 */ … … 485 485 486 486 /** 487 \briefparses a vertexNormal-String488 \param normalString The String that will be parsed.487 * parses a vertexNormal-String 488 * @param normalString The String that will be parsed. 489 489 490 490 If a vertexNormal line is found this function will inject it into the vertexNormal-Array … … 503 503 504 504 /** 505 \briefadds a VertexNormal.506 \param x The x coordinate of the Normal.507 \param y The y coordinate of the Normal.508 \param z The z coordinate of the Normal.505 * adds a VertexNormal. 506 * @param x The x coordinate of the Normal. 507 * @param y The y coordinate of the Normal. 508 * @param z The z coordinate of the Normal. 509 509 510 510 If a vertexNormal line is found this function will inject it into the vertexNormal-Array … … 519 519 520 520 /** 521 \briefparses a vertexTextureCoordinate-String522 \param vTextureString The String that will be parsed.521 * parses a vertexTextureCoordinate-String 522 * @param vTextureString The String that will be parsed. 523 523 524 524 If a vertexTextureCoordinate line is found, … … 540 540 541 541 /** 542 \briefadds a Texture Coordinate543 \param u The u coordinate of the TextureCoordinate.544 \param v The y coordinate of the TextureCoordinate.542 * adds a Texture Coordinate 543 * @param u The u coordinate of the TextureCoordinate. 544 * @param v The y coordinate of the TextureCoordinate. 545 545 546 546 If a TextureCoordinate line is found this function will inject it into the TextureCoordinate-Array … … 556 556 557 557 /** 558 \briefparses a face-string559 \param faceString The String that will be parsed.558 * parses a face-string 559 * @param faceString The String that will be parsed. 560 560 561 561 If a face line is found this function will add it to the glList. … … 615 615 616 616 /** 617 \briefadds a new Face618 \param faceElemCount the number of Vertices to add to the Face.619 \param type The information Passed with each Vertex617 * adds a new Face 618 * @param faceElemCount the number of Vertices to add to the Face. 619 * @param type The information Passed with each Vertex 620 620 */ 621 621 bool Model::addFace(int faceElemCount, VERTEX_FORMAT type, ...) … … 648 648 649 649 /** 650 \briefFunction that selects a material, if changed in the obj file.651 \param matString the Material that will be set.650 * Function that selects a material, if changed in the obj file. 651 * @param matString the Material that will be set. 652 652 */ 653 653 bool Model::setMaterial(const char* matString) … … 663 663 664 664 /** 665 \briefFunction that selects a material, if changed in the obj file.666 \param mtl the Material that will be set.665 * Function that selects a material, if changed in the obj file. 666 * @param mtl the Material that will be set. 667 667 */ 668 668 bool Model::setMaterial(Material* mtl) … … 678 678 679 679 /** 680 \briefA routine that is able to create normals.680 * A routine that is able to create normals. 681 681 682 682 The algorithm does the following: … … 757 757 //////////// 758 758 /** 759 \briefreads and includes the Faces/Materials into the openGL state Machine759 * reads and includes the Faces/Materials into the openGL state Machine 760 760 */ 761 761 bool Model::importToDisplayList() … … 849 849 850 850 /** 851 \briefreads and includes the Faces/Materials into the openGL state Machine851 * reads and includes the Faces/Materials into the openGL state Machine 852 852 */ 853 853 bool Model::importToVertexArray() … … 869 869 870 870 /** 871 \briefbuilds an array of triangles, that can later on be used for obb separation and octree separation871 * builds an array of triangles, that can later on be used for obb separation and octree separation 872 872 */ 873 873 bool Model::buildTriangleList() … … 993 993 994 994 /** 995 \briefAdds a Face-element (one vertex of a face) with all its information.996 \param elem The FaceElement to add to the OpenGL-environment.995 * Adds a Face-element (one vertex of a face) with all its information. 996 * @param elem The FaceElement to add to the OpenGL-environment. 997 997 998 998 It does this by searching: … … 1034 1034 1035 1035 /** 1036 \briefIncludes a default model1036 * Includes a default model 1037 1037 1038 1038 This will inject a Cube, because this is the most basic model. -
orxonox/trunk/src/lib/graphics/importer/model.h
r4834 r4836 24 24 MODEL_DISPLAY_LIST means, that a DisplayList will be built out of the model. This model will be STATIC, meaning it cannot be changed after initialisation. 25 25 MODEL_VERTEX_ARRAY means, that a VertexArray will be built out of the model. This moel will be DYNAMIX, meaning that one can change the properties from outside of the model. 26 * \todo implement this stuff26 * @todo implement this stuff 27 27 */ 28 28 typedef enum MODEL_TYPE { … … 90 90 ModelFace* firstFace; //!< The first Face in this group. 91 91 ModelFace* currentFace; //!< The current Face in this Group (the one we are currently working with.) 92 int faceMode; //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material, 3 for triangle, 4 for Quad, 5+ for Poly \todo ENUM...92 int faceMode; //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material, 3 for triangle, 4 for Quad, 5+ for Poly @todo ENUM... 93 93 int faceCount; //!< The Number of Faces this Group holds. 94 94 … … 111 111 void draw(char* groupName) const; 112 112 113 /** \returns Count of the Models (Groups) in this File */113 /** @returns Count of the Models (Groups) in this File */ 114 114 inline int getGroupCount() const { return this->groupCount; }; 115 115 116 /** \returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */116 /** @returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */ 117 117 inline const GLfloat* getVertexArray() const { return this->vertices->getArray(); }; 118 /** \returns the VertexCount of this Model */118 /** @returns the VertexCount of this Model */ 119 119 inline unsigned int getVertexCount() const { return this->vertexCount; }; 120 120 121 /** \returns a Pointer to the Normals-Array, if it was deleted it returns NULL */121 /** @returns a Pointer to the Normals-Array, if it was deleted it returns NULL */ 122 122 inline const GLfloat* getNormalsArray() const { return this->normals->getArray(); }; 123 /** \returns the NormalsCount of this Model */123 /** @returns the NormalsCount of this Model */ 124 124 inline unsigned int getNormalsCount() const { return this->normalCount; }; 125 125 126 /** \returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */126 /** @returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */ 127 127 inline const GLfloat* getTexCoordArray() const { return this->vTexture->getArray(); }; 128 /** \returns the TexCoord-Count of this Model */128 /** @returns the TexCoord-Count of this Model */ 129 129 inline unsigned int getTexCoordCount() const { return this->texCoordCount; }; 130 130 131 /** \returns the Count of Faces of this Model */131 /** @returns the Count of Faces of this Model */ 132 132 inline unsigned int getFaceCount() const { return this->faceCount; }; 133 133 … … 157 157 158 158 protected: 159 float scaleFactor; //!< The Factor with which the Model should be scaled. \todo maybe one wants to scale the Model after Initialisation159 float scaleFactor; //!< The Factor with which the Model should be scaled. @todo maybe one wants to scale the Model after Initialisation 160 160 161 161 private: -
orxonox/trunk/src/lib/graphics/importer/objModel.cc
r4371 r4836 28 28 29 29 /** 30 \briefCrates a 3D-Model, loads in a File and scales it.31 \param fileName file to parse and load (must be a .obj file)32 \param scaling The factor that the model will be scaled with.30 * Crates a 3D-Model, loads in a File and scales it. 31 * @param fileName file to parse and load (must be a .obj file) 32 * @param scaling The factor that the model will be scaled with. 33 33 */ 34 34 OBJModel::OBJModel(const char* fileName, float scaling) : Model(fileName) … … 44 44 45 45 /** 46 \briefdeletes an OBJModel.46 * deletes an OBJModel. 47 47 48 48 Looks if any from model allocated space is still in use, and if so deleted it. … … 56 56 57 57 /** 58 \briefImports a obj file and handles the the relative location59 \param fileName The file to import58 * Imports a obj file and handles the the relative location 59 * @param fileName The file to import 60 60 61 61 Splits the FileName from the DirectoryName … … 86 86 87 87 /** 88 \briefReads in the .obj File and sets all the Values.88 * Reads in the .obj File and sets all the Values. 89 89 This function does read the file, parses it for the occurence of things like vertices, faces and so on, and executes the specific tasks 90 90 */ … … 143 143 this->addGroup (buffer+2); 144 144 } 145 else if (!strncmp(buffer, "s ", 2)) //! \todo smoothing groups have to be implemented145 else if (!strncmp(buffer, "s ", 2)) //! @todo smoothing groups have to be implemented 146 146 { 147 147 PRINTF(2)("smoothing groups not supportet yet. line: %s\n", buffer); … … 153 153 154 154 /** 155 \briefFunction to read in a mtl File.156 \param mtlFile The .mtl file to read155 * Function to read in a mtl File. 156 * @param mtlFile The .mtl file to read 157 157 158 158 This Function parses all Lines of an mtl File. -
orxonox/trunk/src/lib/graphics/importer/primitive_model.cc
r4678 r4836 25 25 26 26 /** 27 \briefCreates a 3D-Model of Primitive-Type type27 * Creates a 3D-Model of Primitive-Type type 28 28 29 29 if you want to just display a Cube/Sphere/Cylinder/... without any material. 30 30 31 \todo implement Cube/Sphere/Cylinder/...31 @todo implement Cube/Sphere/Cylinder/... 32 32 */ 33 33 PrimitiveModel::PrimitiveModel(PRIMITIVE type, float size, unsigned int detail) … … 56 56 57 57 /** 58 \briefstandard deconstructor58 * standard deconstructor 59 59 60 60 */ … … 65 65 66 66 /** 67 \briefBuilds a Sphere into the Model.68 \param size The diameter of the Sphere.69 \param detail The detail of the Sphere.67 * Builds a Sphere into the Model. 68 * @param size The diameter of the Sphere. 69 * @param detail The detail of the Sphere. 70 70 */ 71 71 void PrimitiveModel::sphereModel(float size, unsigned int detail) … … 132 132 } 133 133 /** 134 \briefCreates a Cylinder.134 * Creates a Cylinder. 135 135 */ 136 136 void PrimitiveModel::cylinderModel(float size, unsigned int detail) … … 173 173 174 174 /** 175 \briefcreates a cone inside of this Model176 \param size The size of the cone177 \param detail the Detail-level of this cone175 * creates a cone inside of this Model 176 * @param size The size of the cone 177 * @param detail the Detail-level of this cone 178 178 */ 179 179 void PrimitiveModel::coneModel(float size, unsigned int detail) … … 209 209 210 210 /** 211 \briefcreates a Plane inside of this Model212 \param size The size of this plane213 \param detail the Detail-level of this plane.211 * creates a Plane inside of this Model 212 * @param size The size of this plane 213 * @param detail the Detail-level of this plane. 214 214 */ 215 215 void PrimitiveModel::planeModel(float size, unsigned int detail) -
orxonox/trunk/src/lib/graphics/importer/primitive_model.h
r4468 r4836 1 1 /*! 2 2 \file primitive_model.h 3 \briefa Class to handle different simple models like planes cubes spheres and so on.3 * a Class to handle different simple models like planes cubes spheres and so on. 4 4 (cube is also an option of Model, but is extended here. 5 5 */ -
orxonox/trunk/src/lib/graphics/importer/texture.cc
r4746 r4836 28 28 29 29 /** 30 \briefConstructor for a Texture30 * Constructor for a Texture 31 31 */ 32 32 Texture::Texture(const char* imageName) … … 39 39 40 40 /** 41 \briefDestructor of a Texture41 * Destructor of a Texture 42 42 43 43 Frees Data, and deletes the textures from GL … … 50 50 51 51 /** 52 \briefLoads a Texture to the openGL-environment.53 \param surface the Image to load to openGL54 \returns The ID of the texture.52 * Loads a Texture to the openGL-environment. 53 * @param surface the Image to load to openGL 54 * @returns The ID of the texture. 55 55 */ 56 56 GLuint Texture::loadTexToGL (SDL_Surface* surface) … … 139 139 140 140 /** 141 \briefloads an Image from a file to a Texture142 \param imageName The image to load141 * loads an Image from a file to a Texture 142 * @param imageName The image to load 143 143 */ 144 144 bool Texture::loadImage(const char* imageName) -
orxonox/trunk/src/lib/graphics/importer/texture.h
r4746 r4836 3 3 \brief Contains the texture class, that handles the reading of Images into Texutre-files. 4 4 5 \todo procedural textures5 @todo procedural textures 6 6 */ 7 7 … … 27 27 ~Texture(); 28 28 29 /** \returns The textureID of this texture. */29 /** @returns The textureID of this texture. */ 30 30 inline GLuint getTexture() {return this->texture;} 31 31 GLuint loadTexToGL (SDL_Surface* surface); 32 /** \returns true if texture has alpha, false otherwise */32 /** @returns true if texture has alpha, false otherwise */ 33 33 inline bool hasAlpha() const {return bAlpha;} 34 34 -
orxonox/trunk/src/lib/graphics/light.cc
r4746 r4836 45 45 46 46 /** 47 * \param root The XML-element to load the Light from48 49 \todo what to do, if no Light-Slots are open anymore ???47 * @param root The XML-element to load the Light from 48 49 @todo what to do, if no Light-Slots are open anymore ??? 50 50 */ 51 51 Light::Light(const TiXmlElement* root) … … 71 71 72 72 /** 73 \briefdestroys a Light73 * destroys a Light 74 74 */ 75 75 Light::~Light() … … 81 81 82 82 /** 83 * \param root The XML-element to load the Light from83 * @param root The XML-element to load the Light from 84 84 */ 85 85 void Light::loadParams(const TiXmlElement* root) … … 104 104 105 105 /** 106 \briefsets an emitting Diffuse color of this Light107 \param r red108 \param g green109 \param b blue106 * sets an emitting Diffuse color of this Light 107 * @param r red 108 * @param g green 109 * @param b blue 110 110 */ 111 111 void Light::setDiffuseColor(GLfloat r, GLfloat g, GLfloat b) … … 120 120 121 121 /** 122 \briefsets an emitting Specular color of this Light123 \param r red124 \param g green125 \param b blue122 * sets an emitting Specular color of this Light 123 * @param r red 124 * @param g green 125 * @param b blue 126 126 */ 127 127 void Light::setSpecularColor(GLfloat r, GLfloat g, GLfloat b) … … 137 137 138 138 /** 139 \briefSets the AttenuationType of this Light Source140 \param constantAttenuation The Constant Attenuation of the Light141 \param linearAttenuation The Linear Attenuation of the Light142 \param quadraticAttenuation The Quadratic Attenuation of the Light139 * Sets the AttenuationType of this Light Source 140 * @param constantAttenuation The Constant Attenuation of the Light 141 * @param linearAttenuation The Linear Attenuation of the Light 142 * @param quadraticAttenuation The Quadratic Attenuation of the Light 143 143 */ 144 144 void Light::setAttenuation(float constantAttenuation, float linearAttenuation, float quadraticAttenuation) … … 155 155 156 156 /** 157 \briefstets the direction of the Spot Light.158 \param direction The direction of the Spot Light.157 * stets the direction of the Spot Light. 158 * @param direction The direction of the Spot Light. 159 159 */ 160 160 void Light::setSpotDirection(const Vector& direction) … … 169 169 170 170 /** 171 \briefsets the cutoff angle of the Light.172 \param cutoff The cutoff angle.171 * sets the cutoff angle of the Light. 172 * @param cutoff The cutoff angle. 173 173 */ 174 174 void Light::setSpotCutoff(GLfloat cutoff) … … 179 179 180 180 /** 181 \briefdraws this Light. Being a World-entity the possibility to do this lies at hand.181 * draws this Light. Being a World-entity the possibility to do this lies at hand. 182 182 */ 183 183 void Light::draw() const … … 190 190 191 191 /** 192 \briefPrints out some nice formated debug information about the Light192 * Prints out some nice formated debug information about the Light 193 193 */ 194 194 void Light::debug() const … … 213 213 ******************/ 214 214 /** 215 \briefstandard constructor for a Light215 * standard constructor for a Light 216 216 */ 217 217 LightManager::LightManager () … … 228 228 229 229 /** 230 \briefstandard deconstructor230 * standard deconstructor 231 231 232 232 first disables Lighting … … 248 248 249 249 /** 250 \briefsingleton-Reference to the Light-class250 * singleton-Reference to the Light-class 251 251 */ 252 252 LightManager* LightManager::singletonRef = NULL; 253 253 254 254 /** 255 \param root the XML-element to load the LightManager's settings from255 * @param root the XML-element to load the LightManager's settings from 256 256 */ 257 257 void LightManager::loadParams(const TiXmlElement* root) … … 265 265 266 266 /** 267 \param root The XML-element to load Lights from267 * @param root The XML-element to load Lights from 268 268 */ 269 269 void LightManager::loadLights(const TiXmlElement* root) … … 281 281 // set Attributes 282 282 /** 283 \briefsets the ambient Color of the Scene284 \param r red285 \param g green286 \param b blue283 * sets the ambient Color of the Scene 284 * @param r red 285 * @param g green 286 * @param b blue 287 287 */ 288 288 void LightManager::setAmbientColor(GLfloat r, GLfloat g, GLfloat b) … … 297 297 298 298 /** 299 \param light the Light to register to the LightManager299 * @param light the Light to register to the LightManager 300 300 301 301 This is done explicitely by the constructor of a Light … … 314 314 315 315 /** 316 \param light The light to unregister from the LightManager316 * @param light The light to unregister from the LightManager 317 317 318 318 This is done every time a Light is destroyed explicitely by the Light-destructor … … 333 333 334 334 /** 335 \briefdraws all the Lights in their appropriate position335 * draws all the Lights in their appropriate position 336 336 */ 337 337 void LightManager::draw() const … … 346 346 347 347 /** 348 \briefoutputs debug information about the Class and its lights348 * outputs debug information about the Class and its lights 349 349 */ 350 350 void LightManager::debug() const -
orxonox/trunk/src/lib/graphics/light.h
r4746 r4836 1 1 /*! 2 2 \file light.h 3 \briefHandles Lights.3 * Handles Lights. 4 4 5 5 A Light is one of the more important things in a 3D-environment, … … 38 38 void setSpotCutoff(GLfloat cutoff); 39 39 40 /** \returns the lightNumber*/40 /** @returns the lightNumber*/ 41 41 int getLightNumber() const {return this->lightNumber;} 42 42 … … 92 92 public: 93 93 virtual ~LightManager(); 94 /** \returns a Pointer to the only object of this Class */94 /** @returns a Pointer to the only object of this Class */ 95 95 inline static LightManager* getInstance() { if (!singletonRef) singletonRef = new LightManager(); return singletonRef; }; 96 96 -
orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.cc
r4819 r4836 22 22 23 23 /** 24 \briefstandard constructor25 \todo this constructor is not jet implemented - do it24 * standard constructor 25 @todo this constructor is not jet implemented - do it 26 26 */ 27 27 Quadtree::Quadtree (modelInfo* pModelInfo) … … 33 33 34 34 /** 35 \briefstandard deconstructor35 * standard deconstructor 36 36 37 37 */ … … 43 43 44 44 /** 45 \briefgives the signal to separate the model into a quadtree45 * gives the signal to separate the model into a quadtree 46 46 */ 47 47 void Quadtree::separate() … … 50 50 51 51 /** 52 \briefdraws the debug quadtree boxes around the model52 * draws the debug quadtree boxes around the model 53 53 */ 54 54 void Quadtree::drawTree(int depth, int drawMode) const -
orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.h
r4819 r4836 1 1 /*! 2 2 \file quadtree.h 3 \briefDefinition of a spatial data separation using quadtree3 * Definition of a spatial data separation using quadtree 4 4 5 5 */ -
orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc
r4819 r4836 22 22 23 23 /** 24 \briefstandard constructor24 * standard constructor 25 25 */ 26 26 QuadtreeNode::QuadtreeNode (sTriangleExt* triangles, int numTriangles, Quadtree* quadtree) … … 31 31 32 32 /** 33 \briefstandard deconstructor33 * standard deconstructor 34 34 35 35 */ … … 41 41 42 42 /** 43 \briefgives the signal to separate the model into a quadtree44 \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached43 * gives the signal to separate the model into a quadtree 44 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached 45 45 */ 46 46 void QuadtreeNode::separateNode(int treeDepth) … … 49 49 50 50 /** 51 \briefgives the signal to separate the model into a quadtree52 \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached51 * gives the signal to separate the model into a quadtree 52 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached 53 53 */ 54 54 void QuadtreeNode::separateNode(float minLength) … … 57 57 58 58 /** 59 \briefdraws the debug quadtree boxes around the model59 * draws the debug quadtree boxes around the model 60 60 */ 61 61 void QuadtreeNode::drawTree(int depth, int drawMode) const -
orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.h
r4819 r4836 1 1 /*! 2 2 \file proto_class.h 3 \briefDefinition of ...3 * Definition of ... 4 4 5 5 */ -
orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.cc
r4819 r4836 24 24 25 25 /** 26 \briefstandard constructor27 \param model the model that is to be separated28 \param overlapSize each box will overlap for a given size26 * standard constructor 27 * @param model the model that is to be separated 28 * @param overlapSize each box will overlap for a given size 29 29 30 30 The boxes are overlaping because this makes collision detection a lot simpler … … 38 38 39 39 /** 40 \briefstandard constructor41 \param model the model that is to be separated42 \param overlapSize each box will overlap for a given size40 * standard constructor 41 * @param model the model that is to be separated 42 * @param overlapSize each box will overlap for a given size 43 43 44 44 The boxes are overlaping because this makes collision detection a lot simpler … … 53 53 54 54 /** 55 \briefstandard deconstructor55 * standard deconstructor 56 56 57 57 */ … … 63 63 /** 64 64 \brief creates a quadtree 65 \param model the model to do a quadtree on66 \param minLength the minimal length of a quadtree node65 * @param model the model to do a quadtree on 66 * @param minLength the minimal length of a quadtree node 67 67 \return the new quadtree 68 68 */ … … 76 76 /** 77 77 \brief creates a quadtree 78 \param model the model to do a quadtree on79 \param minLength the minimal length of a quadtree node78 * @param model the model to do a quadtree on 79 * @param minLength the minimal length of a quadtree node 80 80 \return the new quadtree 81 81 */ … … 88 88 /** 89 89 \brief creates a quadtree 90 \param model the model to do a quadtree on91 \param minLength the minimal length of a quadtree node90 * @param model the model to do a quadtree on 91 * @param minLength the minimal length of a quadtree node 92 92 \return the new quadtree 93 93 */ … … 103 103 /** 104 104 \brief gets the maximal dimension of a model 105 \param playerModel the model that this measurement is based on105 * @param playerModel the model that this measurement is based on 106 106 \return the maximal dimension of the model 107 107 */ -
orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.h
r4819 r4836 1 1 /*! 2 2 \file spatial_separation.h 3 \briefDefinition of the generic spatial separation process of model data3 * Definition of the generic spatial separation process of model data 4 4 5 5 */ -
orxonox/trunk/src/lib/graphics/text_engine.cc
r4834 r4836 42 42 //////////// 43 43 /** 44 \briefcreates a new Text Element45 \param font the Font to render this text in46 \param type The renderType to display this font in44 * creates a new Text Element 45 * @param font the Font to render this text in 46 * @param type The renderType to display this font in 47 47 48 48 this constructor is private, because the user should initialize … … 67 67 68 68 /** 69 \briefdeletes a Text out of memory69 * deletes a Text out of memory 70 70 71 71 This also ereases the text from the textList of the TextEngine … … 77 77 78 78 /** 79 \brieftells the Text, that it should folow a PNode80 \param bindNode: the node to bind this text to79 * tells the Text, that it should folow a PNode 80 * @param bindNode: the node to bind this text to 81 81 */ 82 82 void Text::setBindNode(PNode* bindNode) … … 86 86 87 87 /** 88 \briefsets the Type of this Text89 \param type the type to set.88 * sets the Type of this Text 89 * @param type the type to set. 90 90 */ 91 91 void Text::setType(int type) … … 98 98 99 99 /** 100 \briefSets a new Text to the font101 \param text the new text to set100 * Sets a new Text to the font 101 * @param text the new text to set 102 102 */ 103 103 void Text::setText(const char* text) … … 129 129 130 130 /** 131 \briefsets a Position.132 \param x the x-position in pixels from the left border133 \param y the y-position in pixels from the top border131 * sets a Position. 132 * @param x the x-position in pixels from the left border 133 * @param y the y-position in pixels from the top border 134 134 */ 135 135 void Text::setPosition(int x, int y) … … 140 140 141 141 /** 142 \briefsets the text-alignment143 \param alignment the alignment to set142 * sets the text-alignment 143 * @param alignment the alignment to set 144 144 */ 145 145 void Text::setAlignment(TEXT_ALIGNMENT alignment) … … 149 149 150 150 /** 151 \briefsets a new color to the font152 \param r Red153 \param g Green154 \param b Blue151 * sets a new color to the font 152 * @param r Red 153 * @param g Green 154 * @param b Blue 155 155 */ 156 156 void Text::setColor(Uint8 r, Uint8 g, Uint8 b) … … 162 162 163 163 /** 164 \briefcreates a texture out of the given parameters164 * creates a texture out of the given parameters 165 165 166 166 this has to be called every time by the user, to if changes were made. … … 185 185 186 186 /** 187 \briefdraws the Font187 * draws the Font 188 188 */ 189 189 void Text::draw() const … … 269 269 270 270 /** 271 \briefprints out some nice debug information about this text271 * prints out some nice debug information about this text 272 272 */ 273 273 void Text::debug() const … … 285 285 //////////// 286 286 /** 287 \briefLoads a Font from an SDL_surface into a texture.288 \param surface The surface to make the texture of289 \param texCoord The texture coordinates of the 4 corners of the texture290 \returns the ID of the texture287 * Loads a Font from an SDL_surface into a texture. 288 * @param surface The surface to make the texture of 289 * @param texCoord The texture coordinates of the 4 corners of the texture 290 * @returns the ID of the texture 291 291 */ 292 292 GLuint Text::loadTexture(SDL_Surface *surface, TexCoord* texCoord) … … 366 366 367 367 /** 368 \briefQuick utility function for texture creation369 \param input an integer370 \returns the next bigger 2^n-integer than input368 * Quick utility function for texture creation 369 * @param input an integer 370 * @returns the next bigger 2^n-integer than input 371 371 */ 372 372 int Text::powerOfTwo(int input) … … 385 385 //////////// 386 386 /** 387 \briefconstructs a Font388 \param fontFile the File to load the font from389 \param fontSize the Size of the Font in Pixels390 \param r Red value of the Font.391 \param g Green value of the Font.392 \param b Blue value of the Font.387 * constructs a Font 388 * @param fontFile the File to load the font from 389 * @param fontSize the Size of the Font in Pixels 390 * @param r Red value of the Font. 391 * @param g Green value of the Font. 392 * @param b Blue value of the Font. 393 393 */ 394 394 Font::Font(const char* fontFile, unsigned int fontSize, Uint8 r, Uint8 g, Uint8 b) … … 413 413 414 414 /** 415 \briefdestructs a font415 * destructs a font 416 416 */ 417 417 Font::~Font() … … 433 433 434 434 /** 435 \briefsets The Font.436 \param fontFile The file containing the font.437 \returns true if loaded, false if something went wrong, or if a font was loaded before.435 * sets The Font. 436 * @param fontFile The file containing the font. 437 * @returns true if loaded, false if something went wrong, or if a font was loaded before. 438 438 */ 439 439 bool Font::setFont(const char* fontFile) … … 462 462 463 463 /** 464 \briefsets a specific renderStyle465 \param renderStyle the Style to render: a char-array containing:464 * sets a specific renderStyle 465 * @param renderStyle the Style to render: a char-array containing: 466 466 i: italic, b: bold, u, underline 467 467 */ … … 485 485 486 486 /** 487 \briefSets a new Size to the font488 \param fontSize The new Size in pixels.487 * Sets a new Size to the font 488 * @param fontSize The new Size in pixels. 489 489 */ 490 490 void Font::setSize(unsigned int fontSize) … … 494 494 495 495 /** 496 \briefsets a new color to the font497 \param r Red498 \param g Green499 \param b Blue496 * sets a new color to the font 497 * @param r Red 498 * @param g Green 499 * @param b Blue 500 500 */ 501 501 void Font::setFastColor(Uint8 r, Uint8 g, Uint8 b) … … 507 507 508 508 /** 509 \returns the maximum height of the Font, if the font was initialized, 0 otherwise509 * @returns the maximum height of the Font, if the font was initialized, 0 otherwise 510 510 */ 511 511 int Font::getMaxHeight() … … 518 518 519 519 /** 520 \returns the maximum ascent of the Font, if the font was initialized, 0 otherwise520 * @returns the maximum ascent of the Font, if the font was initialized, 0 otherwise 521 521 522 522 the ascent is the pixels of the font above the baseline … … 531 531 532 532 /** 533 \returns the maximum descent of the Font, if the font was initialized, 0 otherwise533 * @returns the maximum descent of the Font, if the font was initialized, 0 otherwise 534 534 535 535 the descent is the pixels of the font below the baseline … … 544 544 545 545 /** 546 \param character The character to get info about.547 \returns a Glyph struct of a character. This Glyph is a pointer,546 * @param character The character to get info about. 547 * @returns a Glyph struct of a character. This Glyph is a pointer, 548 548 and MUST be deleted by the user.. 549 549 … … 581 581 582 582 this->initGlyphs(32, numberOfGlyphs); 583 this->glyphArray[32]->width = fontSize/3; //!< \todo find out the real size of a Space583 this->glyphArray[32]->width = fontSize/3; //!< @todo find out the real size of a Space 584 584 585 585 int rectSize = this->findOptimalFastTextureSize(); … … 695 695 696 696 /** 697 \briefstores Glyph Metrics in an Array.698 \param from The Glyph to start from.699 \param count The number of Glyphs to start From.697 * stores Glyph Metrics in an Array. 698 * @param from The Glyph to start from. 699 * @param count The number of Glyphs to start From. 700 700 */ 701 701 void Font::initGlyphs(Uint16 from, Uint16 count) … … 722 722 723 723 /** 724 \returns the optimal size to use as the texture size725 726 \todo: this algorithm can be a lot more faster, althought it does724 * @returns the optimal size to use as the texture size 725 726 @todo: this algorithm can be a lot more faster, althought it does 727 727 not really matter within the init-context, and 128 glyphs. 728 728 … … 773 773 774 774 /** 775 \briefa simple function to get some interesting information about this class775 * a simple function to get some interesting information about this class 776 776 */ 777 777 void Font::debug() … … 800 800 /////////////////// 801 801 /** 802 \briefstandard constructor802 * standard constructor 803 803 */ 804 804 TextEngine::TextEngine () … … 812 812 813 813 /** 814 \briefthe singleton reference to this class814 * the singleton reference to this class 815 815 */ 816 816 TextEngine* TextEngine::singletonRef = NULL; 817 817 818 818 /** 819 \briefstandard deconstructor819 * standard deconstructor 820 820 821 821 */ … … 830 830 831 831 /** 832 \brieffunction to enable TTF_Fonts832 * function to enable TTF_Fonts 833 833 */ 834 834 void TextEngine::enableFonts() … … 846 846 847 847 /** 848 \brieffunction to disable TTF_fonts848 * function to disable TTF_fonts 849 849 */ 850 850 void TextEngine::disableFonts() … … 859 859 860 860 /** 861 \briefcreates a new Text with a certain font.861 * creates a new Text with a certain font. 862 862 \see Font::Font 863 863 \see Text::Text … … 884 884 885 885 /** 886 \briefremoves a Text from the List887 \param text: the text to delete886 * removes a Text from the List 887 * @param text: the text to delete 888 888 889 889 this only ereases allocated memory, and removes the text … … 898 898 899 899 /** 900 \briefdeletes all the Text, and tries to delete all allocated fonts900 * deletes all the Text, and tries to delete all allocated fonts 901 901 */ 902 902 void TextEngine::flush() … … 913 913 914 914 /** 915 \briefdraws all the Texts that have been initialized915 * draws all the Texts that have been initialized 916 916 */ 917 917 void TextEngine::draw() const … … 937 937 938 938 /** 939 \briefoutputs some nice Debug information940 941 \todo there should also be something outputted about Font939 * outputs some nice Debug information 940 941 @todo there should also be something outputted about Font 942 942 */ 943 943 void TextEngine::debug() const … … 961 961 962 962 /** 963 \briefchecks if the compiled version and the local version of SDL_ttf match.964 \returns true if match, false otherwise963 * checks if the compiled version and the local version of SDL_ttf match. 964 * @returns true if match, false otherwise 965 965 */ 966 966 bool TextEngine::checkVersion() -
orxonox/trunk/src/lib/graphics/text_engine.h
r4746 r4836 1 1 /*! 2 2 \file text_engine.h 3 \briefDefinition of textEngine, the Font and the Text3 * Definition of textEngine, the Font and the Text 4 4 5 5 Text is the text outputed. … … 116 116 void setPosition(int x, int y); 117 117 void setAlignment(TEXT_ALIGNMENT alignment); 118 /** \param blending the blending intensity to set (between 0.0 and 1.0) */118 /** @param blending the blending intensity to set (between 0.0 and 1.0) */ 119 119 inline void setBlending(float blending) {this->blending = blending;} 120 120 … … 145 145 // placement in openGL 146 146 GLuint texture; //!< A GL-texture to hold the text 147 TexCoord texCoord; //!< Texture-coordinates \todo fix this to have a struct147 TexCoord texCoord; //!< Texture-coordinates @todo fix this to have a struct 148 148 SDL_Rect posSize; //!< An SDL-Rectangle representing the position and size of the Text on the screen. 149 149 … … 174 174 void setStyle(const char* renderStyle); 175 175 176 /** \returns a Pointer to the Array of Glyphs */176 /** @returns a Pointer to the Array of Glyphs */ 177 177 inline Glyph** getGlyphArray() const {return glyphArray;} 178 /** \returns the texture to the fast-texture */178 /** @returns the texture to the fast-texture */ 179 179 inline GLuint getFastTextureID() const {return fastTextureID;} 180 180 … … 217 217 public: 218 218 virtual ~TextEngine(); 219 /** \returns a Pointer to the only object of this Class */219 /** @returns a Pointer to the only object of this Class */ 220 220 inline static TextEngine* getInstance() { if (!singletonRef) singletonRef = new TextEngine(); return singletonRef; }; 221 221 -
orxonox/trunk/src/lib/gui/gui.cc
r4746 r4836 48 48 49 49 /** 50 \briefInitializes the Gui50 * Initializes the Gui 51 51 */ 52 52 Gui::Gui(int argc, char *argv[]) … … 121 121 122 122 /** 123 \briefstarts the OrxonoxGUI123 * starts the OrxonoxGUI 124 124 */ 125 125 void Gui::startGui() … … 138 138 139 139 /** 140 \briefa bool that knows if orxonox should be started140 * a bool that knows if orxonox should be started 141 141 */ 142 142 bool Gui::startOrxonox = false; 143 143 144 144 /** 145 \briefDestructor.145 * Destructor. 146 146 */ 147 147 Gui::~Gui() -
orxonox/trunk/src/lib/gui/gui.h
r4746 r4836 3 3 \brief Creation of the Gui 4 4 5 \todo way to start gui without GTK (textmode) AND IMPROOVE6 \todo curl interface to Download cool stuff5 @todo way to start gui without GTK (textmode) AND IMPROOVE 6 @todo curl interface to Download cool stuff 7 7 8 \todo widgets save themselves9 \todo good way to step through all the Widgets10 \todo label -> protected : getlabel function8 @todo widgets save themselves 9 @todo good way to step through all the Widgets 10 @todo label -> protected : getlabel function 11 11 */ 12 12 -
orxonox/trunk/src/lib/gui/gui_audio.cc
r4746 r4836 29 29 30 30 /** 31 \briefCreates an Audio-Frame31 * Creates an Audio-Frame 32 32 */ 33 33 GuiAudio::GuiAudio() … … 72 72 73 73 /** 74 \briefDestructs the Audio-Stuff74 * Destructs the Audio-Stuff 75 75 */ 76 76 GuiAudio::~GuiAudio() -
orxonox/trunk/src/lib/gui/gui_banner.cc
r4746 r4836 32 32 33 33 /** 34 \briefCreates a new BannerEventBox and its content.34 * Creates a new BannerEventBox and its content. 35 35 */ 36 36 GuiBanner::GuiBanner() … … 75 75 logoBox->fill(logoImage); 76 76 77 //! \todo add the names of all the guys working on orxonox77 //! @todo add the names of all the guys working on orxonox 78 78 orxIsLabel = new Label(" " PACKAGE_NAME " is:\n" ORXONOX_STAFF); 79 79 logoBox->fill(orxIsLabel); … … 90 90 91 91 /** 92 \briefDestructs it.92 * Destructs it. 93 93 */ 94 94 GuiBanner::~GuiBanner() -
orxonox/trunk/src/lib/gui/gui_element.cc
r4427 r4836 24 24 25 25 /** 26 \briefstandard constructor27 \todo this constructor is not jet implemented - do it26 * standard constructor 27 @todo this constructor is not jet implemented - do it 28 28 */ 29 29 GuiElement::GuiElement () … … 34 34 35 35 /** 36 \briefstandard deconstructor36 * standard deconstructor 37 37 38 38 */ … … 43 43 44 44 /** 45 \briefEvery GuiElement should set this, or it could result in a SegFault.45 * Every GuiElement should set this, or it could result in a SegFault. 46 46 */ 47 47 void GuiElement::setMainWidget(Widget* widget) -
orxonox/trunk/src/lib/gui/gui_element.h
r4746 r4836 1 1 /*! 2 2 \file gui_element.h 3 \briefDefinition of ...3 * Definition of ... 4 4 5 5 */ … … 17 17 virtual ~GuiElement(); 18 18 19 /** \returns the main Widget of this GuiElement. */19 /** @returns the main Widget of this GuiElement. */ 20 20 Widget* getWidget() {return this->mainWidget;} 21 21 protected: -
orxonox/trunk/src/lib/gui/gui_exec.cc
r4830 r4836 39 39 40 40 /** 41 \briefCreates the Exec-Frame41 * Creates the Exec-Frame 42 42 */ 43 43 GuiExec::GuiExec() … … 56 56 { 57 57 Button* start; //!< The start Button of orxonox. 58 Menu* verboseMode; //!< A Menu for setting the verbose-Mode. \todo setting up a verbose-class.58 Menu* verboseMode; //!< A Menu for setting the verbose-Mode. @todo setting up a verbose-class. 59 59 CheckButton* alwaysShow; //!< A CheckButton, for if orxonox should start with or without gui. 60 60 Button* quit; //!< A Button to quit the Gui without starting orxonox. … … 131 131 132 132 /** 133 \briefDestructs the Execution-stuff133 * Destructs the Execution-stuff 134 134 */ 135 135 GuiExec::~GuiExec() … … 144 144 145 145 /** 146 \briefsets the Directory of the configuration files147 \param confDir the Directory for the configuration files146 * sets the Directory of the configuration files 147 * @param confDir the Directory for the configuration files 148 148 */ 149 149 void GuiExec::setConfDir(const char* confDir) … … 161 161 162 162 /** 163 \briefSets the location of the configuration File.164 \param fileName the location of the configFile163 * Sets the location of the configuration File. 164 * @param fileName the location of the configFile 165 165 166 166 The name will be parsed from ~/ to /home/[username] on unix and c:/Documents and Settings/username/Settings/ on Windows … … 176 176 177 177 /** 178 \returns The name of the Configuration-File178 * @returns The name of the Configuration-File 179 179 */ 180 180 const char* GuiExec::getConfigFile() const … … 184 184 185 185 /** 186 \briefchecks if a option should be saved.187 \return 1 if it should 0 if not/186 * checks if a option should be saved. 187 * @return 1 if it should 0 if not/ 188 188 */ 189 189 int GuiExec::shouldsave() … … 193 193 194 194 /** 195 \briefSaves the configuration-file to the Disk.\n196 \param widget from which Widget on should be saved.195 * Saves the configuration-file to the Disk.\n 196 * @param widget from which Widget on should be saved. 197 197 198 198 this Function only opens and closes the file, in between GuiExec::writeFileText(Widget* widget) will execute the real writing process. … … 207 207 208 208 /** 209 \briefActually writes into the configuration file to the disk.210 \param widget from which Widget on should be saved.211 \param depth initially "0", and grows higher, while new Groups are bundeled.209 * Actually writes into the configuration file to the disk. 210 * @param widget from which Widget on should be saved. 211 * @param depth initially "0", and grows higher, while new Groups are bundeled. 212 212 */ 213 213 void GuiExec::writeFileText(Widget* widget, int depth) … … 258 258 259 259 /** 260 \briefReads in Configuration Data.261 \param widget from which Widget on should be saved.260 * Reads in Configuration Data. 261 * @param widget from which Widget on should be saved. 262 262 */ 263 263 void GuiExec::readFromFile(Widget* widget) … … 307 307 308 308 /** 309 \briefMaps Confugurations to the Options.310 \param widget which widget downwards311 \param varInfo Information about the Variable to read309 * Maps Confugurations to the Options. 310 * @param widget which widget downwards 311 * @param varInfo Information about the Variable to read 312 312 */ 313 313 void GuiExec::readFileText(Widget* widget, void* varInfo) … … 323 323 324 324 /** 325 \briefLocates a Group.326 \param widget The Widget from where to search from327 \param groupName The GroupName for which to search.328 \param depth The Depth of the search seen from the first widget we searched from.329 \returns The Widget that holds the Group, or the NULL if the Group wasn't found.330 331 \todo do this in gui-gtk.325 * Locates a Group. 326 * @param widget The Widget from where to search from 327 * @param groupName The GroupName for which to search. 328 * @param depth The Depth of the search seen from the first widget we searched from. 329 * @returns The Widget that holds the Group, or the NULL if the Group wasn't found. 330 331 @todo do this in gui-gtk. 332 332 */ 333 333 Widget* GuiExec::locateGroup(Widget* widget, char* groupName, int depth) … … 365 365 366 366 /** 367 \briefStarts ORXONOX.(not really implemented yet, but the function is there.\n368 \param widget the widget that executed the start command369 \param data additional data367 * Starts ORXONOX.(not really implemented yet, but the function is there.\n 368 * @param widget the widget that executed the start command 369 * @param data additional data 370 370 371 371 This is a Signal and can be executed through Widget::signal_connect … … 390 390 391 391 /** 392 \briefStarts ORXONOX.(not really implemented yet, but the function is there.\n393 \param widget the widget that executed the start command394 \param data additional data392 * Starts ORXONOX.(not really implemented yet, but the function is there.\n 393 * @param widget the widget that executed the start command 394 * @param data additional data 395 395 396 396 This is a Signal and can be executed through Widget::signal_connect -
orxonox/trunk/src/lib/gui/gui_flags.cc
r4746 r4836 27 27 28 28 /** 29 \briefCreates the Flags-Frame29 * Creates the Flags-Frame 30 30 */ 31 31 GuiFlags::GuiFlags() … … 46 46 47 47 /** 48 \briefDestructs the Flags-stuff48 * Destructs the Flags-stuff 49 49 */ 50 50 GuiFlags::~GuiFlags() … … 54 54 55 55 /** 56 \briefSets the Flags from widget downwards.57 \param widget the Widget from which on to scan for deeper Options and their settings.56 * Sets the Flags from widget downwards. 57 * @param widget the Widget from which on to scan for deeper Options and their settings. 58 58 */ 59 59 void GuiFlags::setTextFromFlags(Widget* widget) … … 70 70 71 71 /** 72 \briefthis actually sets the flagtext, and appends it to flagText73 \param widget like GuiFlags::setTextFromFlags(widget)74 \param flagInfo Information aboout the Flag that should be updated.72 * this actually sets the flagtext, and appends it to flagText 73 * @param widget like GuiFlags::setTextFromFlags(widget) 74 * @param flagInfo Information aboout the Flag that should be updated. 75 75 */ 76 76 void GuiFlags::flagsText(Widget* widget, void* flagInfo) -
orxonox/trunk/src/lib/gui/gui_flags.h
r4746 r4836 17 17 Frame* flagsFrame; //!< The Frame that holds the flagsDisplay. 18 18 Box* flagsBox; //!< The Box that holds the flagsDisplay. 19 CheckButton* shortFlags; //!< CheckButton to change the display of short and long flags \todo show long if long not availible...19 CheckButton* shortFlags; //!< CheckButton to change the display of short and long flags @todo show long if long not availible... 20 20 Label* flagsLabel; //!< The Label of the Flags 21 21 -
orxonox/trunk/src/lib/gui/gui_gtk.cc
r4746 r4836 42 42 43 43 /** 44 \briefInitializes the Guis GTK-stuff.45 \param argc the argument count.46 \param argv The Argument strings.44 * Initializes the Guis GTK-stuff. 45 * @param argc the argument count. 46 * @param argv The Argument strings. 47 47 */ 48 48 bool initGUI(int argc, char *argv[]) … … 64 64 65 65 /** 66 \briefenters the GUI's main-loop66 * enters the GUI's main-loop 67 67 */ 68 68 bool mainloopGUI() … … 128 128 129 129 // here follows the rest.... this will be nasty. 130 //! \todo finish it.131 //! \todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it.130 //! @todo finish it. 131 //! @todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it. 132 132 } 133 133 #endif /* HAVE_GTK2 */ … … 144 144 //////////// 145 145 /** 146 \briefconstructs a Widget146 * constructs a Widget 147 147 */ 148 148 Widget::Widget() … … 153 153 154 154 /** 155 \briefdeletes any given Widget155 * deletes any given Widget 156 156 This is still pretty crappy. 157 157 */ … … 170 170 this->next = NULL; 171 171 172 //! \todo not hiding widget, deleting.172 //! @todo not hiding widget, deleting. 173 173 // this->hide(); 174 174 // gtk_destroy_widget(this->widget); … … 176 176 177 177 /** 178 \briefsets a new Title to a Widget179 \param title The new Title to set to the Widget178 * sets a new Title to a Widget 179 * @param title The new Title to set to the Widget 180 180 */ 181 181 void Widget::setTitle(const char* title) … … 188 188 189 189 /** 190 \briefmakes the widget visible.190 * makes the widget visible. 191 191 */ 192 192 void Widget::show() … … 198 198 199 199 /** 200 \briefhides the widget.200 * hides the widget. 201 201 */ 202 202 void Widget::hide() … … 208 208 209 209 /** 210 \briefSets the resolution of a specific widget to the given size.211 \param width the width of the widget to set.212 \param height the height of the widget to set.210 * Sets the resolution of a specific widget to the given size. 211 * @param width the width of the widget to set. 212 * @param height the height of the widget to set. 213 213 */ 214 214 void Widget::setSize(int width, int height) … … 220 220 221 221 /** 222 \briefsearches through widgets for a Name.222 * searches through widgets for a Name. 223 223 */ 224 224 Widget* Widget::findWidgetByName(char* name, unsigned int depth) … … 242 242 243 243 /** 244 \briefMoves through all the Widgets downwards from this and executes the function on them.245 \param function must be of type void and takes a Widget* as an Input.246 \param depth the current depth. if > 0 then the next Widget will also be walked through.244 * Moves through all the Widgets downwards from this and executes the function on them. 245 * @param function must be of type void and takes a Widget* as an Input. 246 * @param depth the current depth. if > 0 then the next Widget will also be walked through. 247 247 */ 248 248 void Widget::walkThrough(void(*function)(Widget*), unsigned int depth) … … 259 259 260 260 /** 261 \briefMoves through all the Widgets downwards from this and executes the function on them.262 \param function must be of type void and takes a Widget* as an Input.263 \param data Additional Data you want to pass to the function.264 \param depth the current depth. if > 0 then the next Widget will also be walked through.261 * Moves through all the Widgets downwards from this and executes the function on them. 262 * @param function must be of type void and takes a Widget* as an Input. 263 * @param data Additional Data you want to pass to the function. 264 * @param depth the current depth. if > 0 then the next Widget will also be walked through. 265 265 */ 266 266 void Widget::walkThrough(void(*function)(Widget*, void*), void* data, unsigned int depth) … … 276 276 277 277 /** 278 \briefThis is for listing the options of "widget"279 \param widget specifies the widget that should be listed278 * This is for listing the options of "widget" 279 * @param widget specifies the widget that should be listed 280 280 */ 281 281 void Widget::listOptionsAndGroups(Widget* widget) … … 290 290 291 291 /** 292 \briefThis is for listing the options of "widget"293 \param widget specifies the widget that should be listed292 * This is for listing the options of "widget" 293 * @param widget specifies the widget that should be listed 294 294 */ 295 295 void Widget::listOptions(Widget* widget) … … 300 300 301 301 /** 302 \briefThis is for listing the options of "widget"303 \param widget specifies the widget that should be listed304 \param data A Counter, that always knows how many Options have been found yet.302 * This is for listing the options of "widget" 303 * @param widget specifies the widget that should be listed 304 * @param data A Counter, that always knows how many Options have been found yet. 305 305 */ 306 306 void Widget::listOptions(Widget* widget, void* data) … … 318 318 319 319 /** 320 \briefThis is for listing the options of "widget"321 \param widget specifies the widget that should be listed322 \param data A Counter, that always knows how many Options have been found yet.320 * This is for listing the options of "widget" 321 * @param widget specifies the widget that should be listed 322 * @param data A Counter, that always knows how many Options have been found yet. 323 323 */ 324 324 void Widget::printHelp(Widget* widget) … … 358 358 359 359 /** 360 \briefFinds an Option by a given number(the n'th option found away from this Widget)361 \param number The Count of options to wait(by reference)362 \param depth The depth of the sarch. if 0 it will not search next pointer360 * Finds an Option by a given number(the n'th option found away from this Widget) 361 * @param number The Count of options to wait(by reference) 362 * @param depth The depth of the sarch. if 0 it will not search next pointer 363 363 364 \todo should return Option* would be much sexier.364 @todo should return Option* would be much sexier. 365 365 */ 366 366 Widget* Widget::findOptionByNumber(int* number, unsigned int depth) … … 387 387 388 388 /** 389 \briefThis is for listing the groups of "widget"390 \param widget specifies the widget that should be listed389 * This is for listing the groups of "widget" 390 * @param widget specifies the widget that should be listed 391 391 */ 392 392 void Widget::listGroups(Widget* widget) … … 397 397 398 398 /** 399 \briefThis is for listing the Groups of "widget". It also displays the n'th number found.400 \param widget specifies the widget that should be listed401 \param data the Counter, that will show the number(this function will raise it by one if a Group is fount.399 * This is for listing the Groups of "widget". It also displays the n'th number found. 400 * @param widget specifies the widget that should be listed 401 * @param data the Counter, that will show the number(this function will raise it by one if a Group is fount. 402 402 */ 403 403 void Widget::listGroups(Widget* widget, void* data) … … 409 409 410 410 /** 411 \briefFinds a Group by a given number(the n'th Group found away from this Widget)412 \param number The Count of options to wait(by reference)413 \param depth The depth of the sarch. if 0 it will not search next pointer411 * Finds a Group by a given number(the n'th Group found away from this Widget) 412 * @param number The Count of options to wait(by reference) 413 * @param depth The depth of the sarch. if 0 it will not search next pointer 414 414 */ 415 415 Widget* Widget::findGroupByNumber(int* number, unsigned int depth) … … 436 436 437 437 /** 438 \briefThis is for setting the option of "widget"439 \param widget specifies the widget that should be set.438 * This is for setting the option of "widget" 439 * @param widget specifies the widget that should be set. 440 440 */ 441 441 void Widget::setOptions(Widget* widget) … … 446 446 447 447 /** 448 \briefredraws all the Widgets down from widget449 \param widget The topmost Widget450 \param data ...448 * redraws all the Widgets down from widget 449 * @param widget The topmost Widget 450 * @param data ... 451 451 */ 452 452 void Widget::redrawOptions(Widget* widget) … … 457 457 458 458 /** 459 \briefWalks through all the Flags given at startuptime.459 * Walks through all the Flags given at startuptime. 460 460 */ 461 461 void Widget::flagCheck(Widget* widget, void* flagName) … … 510 510 #ifdef HAVE_GTK2 511 511 /** 512 \briefConnect any signal to any given Sub-widget512 * Connect any signal to any given Sub-widget 513 513 */ 514 514 gulong Widget::connectSignal(char* event, gint(*signal)(GtkWidget*, GdkEvent*, void *)) … … 518 518 519 519 /** 520 \briefConnect a signal with additionally passing the whole Object520 * Connect a signal with additionally passing the whole Object 521 521 */ 522 522 gulong Widget::connectSignal(char* event, gint(*signal)( GtkWidget*, Widget *)) … … 526 526 527 527 /** 528 \briefConnect a signal with additionally passing a whole external Object528 * Connect a signal with additionally passing a whole external Object 529 529 */ 530 530 gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEvent*, void *)) … … 534 534 535 535 /** 536 \briefConnect a signal with additionally passing a whole external Object536 * Connect a signal with additionally passing a whole external Object 537 537 */ 538 538 gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, void *)) … … 542 542 543 543 /** 544 \briefConnect a signal with additionally passing a whole external Object544 * Connect a signal with additionally passing a whole external Object 545 545 */ 546 546 gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEventKey*, void *)) … … 555 555 556 556 /** 557 \briefSignal that does absolutely nothing558 \param widget The widget that initiated the Signal559 \param event The event-type.560 \param nothing nothin.557 * Signal that does absolutely nothing 558 * @param widget The widget that initiated the Signal 559 * @param event The event-type. 560 * @param nothing nothin. 561 561 */ 562 562 gint Widget::doNothingSignal(GtkWidget *widget, GdkEvent* event, void* nothing) … … 569 569 ///////////// 570 570 /** 571 \briefConstructs a Packer571 * Constructs a Packer 572 572 */ 573 573 Packer::Packer() … … 578 578 579 579 /** 580 \briefDestroys a Packer.580 * Destroys a Packer. 581 581 */ 582 582 Packer::~Packer() … … 592 592 593 593 /** 594 \briefSets the group name under which all the lower widgets of this will be saved.595 \param name The name of the group.594 * Sets the group name under which all the lower widgets of this will be saved. 595 * @param name The name of the group. 596 596 */ 597 597 void Packer::setGroupName(const char* name) … … 607 607 //////////////// 608 608 /** 609 \briefInitializes a Container.609 * Initializes a Container. 610 610 611 611 sets the Container-Specific defaults. … … 617 617 618 618 /** 619 \briefDestroys a Container.619 * Destroys a Container. 620 620 */ 621 621 Container::~Container() … … 625 625 626 626 /** 627 \briefFills a Container with lowerWidget.628 \param lowerWidget the Widget that should be filled into the Container.627 * Fills a Container with lowerWidget. 628 * @param lowerWidget the Widget that should be filled into the Container. 629 629 630 630 It does this by filling up the down pointer only if down points to NULL. … … 645 645 646 646 /** 647 \param borderwidth sets the Width of the border647 * @param borderwidth sets the Width of the border 648 648 */ 649 649 void Container::setBorderWidth(int borderwidth) … … 661 661 662 662 /** 663 \briefThe main Window of Th Gui663 * The main Window of Th Gui 664 664 */ 665 665 Window* Window::mainWindow = NULL; 666 666 667 667 /** 668 \briefCreating a Window with a name669 \param windowName the name the window should get.668 * Creating a Window with a name 669 * @param windowName the name the window should get. 670 670 */ 671 671 Window::Window(const char* windowName) … … 692 692 693 693 /** 694 \briefDestructs a Window.694 * Destructs a Window. 695 695 */ 696 696 Window::~Window() … … 700 700 701 701 /** 702 \briefAdds a new Window Windows to the List of Windows.703 \param windowToAdd The Windows that should be added to the List704 \todo this instead of windowToAdd(possibly)702 * Adds a new Window Windows to the List of Windows. 703 * @param windowToAdd The Windows that should be added to the List 704 @todo this instead of windowToAdd(possibly) 705 705 */ 706 706 void Window::addWindow(Window* windowToAdd) … … 723 723 724 724 /** 725 \briefShows all Widgets that are included within this->widget.725 * Shows all Widgets that are included within this->widget. 726 726 */ 727 727 void Window::showall() … … 736 736 737 737 /** 738 \briefSet The Window-title to title739 \param title title the Window should get.738 * Set The Window-title to title 739 * @param title title the Window should get. 740 740 */ 741 741 void Window::setTitle(const char* title) … … 751 751 752 752 /** 753 \briefopens up a Window and fixes the Focus to it753 * opens up a Window and fixes the Focus to it 754 754 */ 755 755 void Window::open() … … 766 766 767 767 /** 768 \briefcloses up a Window and removes the Focus from it768 * closes up a Window and removes the Focus from it 769 769 */ 770 770 void Window::close() … … 781 781 782 782 /** 783 \briefopens up a window(not topmost Window).783 * opens up a window(not topmost Window). 784 784 this is the Signal that does it. !!SIGNALS ARE STATIC!! 785 \param widget the widget that did it.786 \param event the event that did it.787 \param window the Window that should be opened785 * @param widget the widget that did it. 786 * @param event the event that did it. 787 * @param window the Window that should be opened 788 788 */ 789 789 #ifdef HAVE_GTK2 … … 797 797 798 798 /** 799 \briefcloses a window(not topmost Window).799 * closes a window(not topmost Window). 800 800 this is the Signal that does it. !!SIGNALS ARE STATIC!! 801 \param widget the widget that did it!802 \param event the event that did it!803 \param window the Window that should be closed801 * @param widget the widget that did it! 802 * @param event the event that did it! 803 * @param window the Window that should be closed 804 804 */ 805 805 #ifdef HAVE_GTK2 … … 816 816 /////////// 817 817 /** 818 \briefCreates a new Frame with name title818 * Creates a new Frame with name title 819 819 */ 820 820 Frame::Frame(const char* frameName) … … 829 829 830 830 /** 831 \briefdestrcucts a Frame831 * destrcucts a Frame 832 832 */ 833 833 Frame::~Frame() … … 837 837 838 838 /** 839 \briefSets the Frames name to title840 \param title The title the Frame should get.839 * Sets the Frames name to title 840 * @param title The title the Frame should get. 841 841 */ 842 842 void Frame::setTitle(const char* title) … … 855 855 ////////////// 856 856 /** 857 \briefCreates a new EventBox with name title858 \param eventBoxName title the Eventbox should get(only data-structure-internal)857 * Creates a new EventBox with name title 858 * @param eventBoxName title the Eventbox should get(only data-structure-internal) 859 859 */ 860 860 EventBox::EventBox(const char* eventBoxName) … … 870 870 871 871 /** 872 \briefdestructs an EventBox.872 * destructs an EventBox. 873 873 */ 874 874 EventBox::~EventBox() … … 881 881 ///////// 882 882 /** 883 \briefCreates a new Box of type boxtype884 \param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally883 * Creates a new Box of type boxtype 884 * @param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally 885 885 */ 886 886 Box::Box(char boxtype) … … 897 897 898 898 /** 899 \briefdestructs a Box.899 * destructs a Box. 900 900 */ 901 901 Box::~Box() … … 905 905 906 906 /** 907 \briefFills a box with a given Widget.908 \param lowerWidget the next Widget that should be appendet to this Box907 * Fills a box with a given Widget. 908 * @param lowerWidget the next Widget that should be appendet to this Box 909 909 910 910 It does this by apending the first one to its down-pointer and all its following ones to the preceding next-pointer. The last one will receive a NULL pointer as Next … … 931 931 //////////// 932 932 /** 933 \briefInitializes a new Option.933 * Initializes a new Option. 934 934 sets all Option-Specific-Values to their defaults. 935 935 */ … … 948 948 949 949 /** 950 \briefDestroys an Option.950 * Destroys an Option. 951 951 */ 952 952 Option::~Option() … … 964 964 965 965 /** 966 \param defaultValue new defaultValue for this option966 * @param defaultValue new defaultValue for this option 967 967 */ 968 968 void Option::setDefaultValue(int defaultValue) … … 972 972 973 973 /** 974 \briefThis sets The FlagName of an Option and defines its default Values974 * This sets The FlagName of an Option and defines its default Values 975 975 !! Options will be saved if flagname is different from NULL !! 976 \param flagname the Name that will be displayed in the output977 \param defaultvalue the default Value for this Option(see definition of defaultvalue976 * @param flagname the Name that will be displayed in the output 977 * @param defaultvalue the default Value for this Option(see definition of defaultvalue 978 978 */ 979 979 void Option::setFlagName(const char* flagname, int defaultvalue) … … 996 996 997 997 /** 998 \briefsee Option::setFlagName(char* flagname, int defaultvalue)999 \param flagname the Name that will be displayed in the output1000 \param defaultvalue the default Value for this Option(see definition of defaultvalue1001 \param flagnameshort a short flagname to be displayed in the output998 * see Option::setFlagName(char* flagname, int defaultvalue) 999 * @param flagname the Name that will be displayed in the output 1000 * @param defaultvalue the default Value for this Option(see definition of defaultvalue 1001 * @param flagnameshort a short flagname to be displayed in the output 1002 1002 */ 1003 1003 void Option::setFlagName(const char* flagname, const char* flagnameshort, int defaultvalue) … … 1037 1037 1038 1038 /** 1039 \briefSets the saveable-state of the option.1040 \param isSaveable the saveable-state to set.1039 * Sets the saveable-state of the option. 1040 * @param isSaveable the saveable-state to set. 1041 1041 */ 1042 1042 void Option::saveability(bool isSaveable) … … 1046 1046 1047 1047 /** 1048 \briefsaves an Option1049 \returns the String that should be saved. (this string __should__ be deleted)1048 * saves an Option 1049 * @returns the String that should be saved. (this string __should__ be deleted) 1050 1050 1051 1051 this is a default Option save … … 1059 1059 1060 1060 /** 1061 \briefloads an Option from of its loadString1062 \param loadString the string from which to load the data from1061 * loads an Option from of its loadString 1062 * @param loadString the string from which to load the data from 1063 1063 */ 1064 1064 void Option::load(char* loadString) … … 1070 1070 1071 1071 /** 1072 \returns The saveable-state.1072 * @returns The saveable-state. 1073 1073 */ 1074 1074 bool Option::isSaveable() … … 1079 1079 #ifdef HAVE_GTK2 1080 1080 /** 1081 \briefSignal OptionChange writes the Value from the Option to its Object-Database.1082 \param widget The widget(Option) that has a changed Value1083 \param option the Option-Object that should receive the change.1081 * Signal OptionChange writes the Value from the Option to its Object-Database. 1082 * @param widget The widget(Option) that has a changed Value 1083 * @param option the Option-Object that should receive the change. 1084 1084 */ 1085 1085 gint Option::OptionChange(GtkWidget *widget, Widget* option) … … 1096 1096 //////////// 1097 1097 /** 1098 \briefCreates a new Button with a buttonname1099 \param buttonName sets the Name of the Button1098 * Creates a new Button with a buttonname 1099 * @param buttonName sets the Name of the Button 1100 1100 */ 1101 1101 Button::Button(const char* buttonName) … … 1112 1112 1113 1113 /** 1114 \briefdestructs a Button.1114 * destructs a Button. 1115 1115 */ 1116 1116 Button::~Button() … … 1120 1120 1121 1121 /** 1122 \briefSets a new name to the Button1123 \param title The name the Button should get1122 * Sets a new name to the Button 1123 * @param title The name the Button should get 1124 1124 */ 1125 1125 void Button::setTitle(const char *title) … … 1135 1135 1136 1136 /** 1137 \briefredraws the Button1138 \todo not implemented yet1137 * redraws the Button 1138 @todo not implemented yet 1139 1139 */ 1140 1140 void Button::redraw() … … 1143 1143 1144 1144 /** 1145 \briefButton can not be changed, optionChange is empty)1146 1147 \todo Actions for non-GTK-mode1145 * Button can not be changed, optionChange is empty) 1146 1147 @todo Actions for non-GTK-mode 1148 1148 */ 1149 1149 void Button::changeOption() … … 1156 1156 ///////////////// 1157 1157 /** 1158 \briefCreates a new CheckButton with an ame1159 \param buttonName The name the CheckButton should display.1158 * Creates a new CheckButton with an ame 1159 * @param buttonName The name the CheckButton should display. 1160 1160 */ 1161 1161 CheckButton::CheckButton(const char* buttonName) … … 1176 1176 1177 1177 /** 1178 \briefdestructs a CheckButton.1178 * destructs a CheckButton. 1179 1179 */ 1180 1180 CheckButton::~CheckButton() … … 1187 1187 1188 1188 /** 1189 \briefSets a new Title to a CheckButton1190 \param title The new Name the CheckButton should display.1189 * Sets a new Title to a CheckButton 1190 * @param title The new Name the CheckButton should display. 1191 1191 */ 1192 1192 void CheckButton::setTitle(const char* title) … … 1202 1202 1203 1203 /** 1204 \returns the Active state of the checkButton1204 * @returns the Active state of the checkButton 1205 1205 */ 1206 1206 bool CheckButton::isActive() … … 1212 1212 1213 1213 /** 1214 \briefChanged the Option, call this Function1214 * Changed the Option, call this Function 1215 1215 */ 1216 1216 void CheckButton::changeOption() … … 1231 1231 1232 1232 /** 1233 \briefRedraws the CheckButton(if option has changed).1233 * Redraws the CheckButton(if option has changed). 1234 1234 Example: if new settings are loaded the Button must be redrawn for the GUI to display that Change 1235 1235 */ … … 1245 1245 //////////// 1246 1246 /** 1247 \briefCreates a new Slider1248 \param slidername The data-structure-name of the slider.1249 \param start The minimal Value of the slider.1250 \param end The maximal Value of the slider.1247 * Creates a new Slider 1248 * @param slidername The data-structure-name of the slider. 1249 * @param start The minimal Value of the slider. 1250 * @param end The maximal Value of the slider. 1251 1251 */ 1252 1252 Slider::Slider(const char* slidername, float start, float end) … … 1268 1268 1269 1269 /** 1270 \briefdestructs a Slider.1270 * destructs a Slider. 1271 1271 */ 1272 1272 Slider::~Slider() … … 1276 1276 1277 1277 /** 1278 \briefsets the exactness of the widget1279 \param exactness count of digits after the dot1278 * sets the exactness of the widget 1279 * @param exactness count of digits after the dot 1280 1280 */ 1281 1281 void Slider::setExactness(int exactness) … … 1288 1288 1289 1289 /** 1290 \briefSetting a new value to the Slider.1290 * Setting a new value to the Slider. 1291 1291 Maybe you also require a Slider::redraw() for this to display 1292 1292 */ … … 1297 1297 1298 1298 /** 1299 \briefRedraws the widget1299 * Redraws the widget 1300 1300 Example: see void CheckButton::redraw() 1301 1301 */ … … 1308 1308 1309 1309 /** 1310 \briefChanged the Option, call this Function1310 * Changed the Option, call this Function 1311 1311 */ 1312 1312 void Slider::changeOption() … … 1346 1346 ////////// 1347 1347 /** 1348 \briefconstructs a new Menu, without adding any items to it.1349 \param menuName the Name the Menu gets.1348 * constructs a new Menu, without adding any items to it. 1349 * @param menuName the Name the Menu gets. 1350 1350 */ 1351 1351 Menu::Menu(const char* menuName) … … 1356 1356 1357 1357 /** 1358 \briefCreates a Menu-Item-list out of multiple input.1358 * Creates a Menu-Item-list out of multiple input. 1359 1359 !! Consider, that the last input argument has to be "lastItem" for this to work!! 1360 \param menuname The Database-Name of this Menu1361 \param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!1360 * @param menuname The Database-Name of this Menu 1361 * @param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!! 1362 1362 */ 1363 1363 Menu::Menu(char* menuname, ...) … … 1378 1378 1379 1379 /** 1380 \briefdestructs a Menu.1380 * destructs a Menu. 1381 1381 */ 1382 1382 Menu::~Menu() … … 1387 1387 { 1388 1388 delete []this->currItem->name; 1389 //! \todo destroy menu1389 //! @todo destroy menu 1390 1390 /* 1391 1391 #ifdef HAVE_GTK2 … … 1399 1399 1400 1400 /** 1401 \briefInitializes a new Menu with no items1401 * Initializes a new Menu with no items 1402 1402 */ 1403 1403 void Menu::init() … … 1415 1415 1416 1416 /** 1417 \briefsaves the Label of the Menu1418 \returns the name of the selected Menu-Item1417 * saves the Label of the Menu 1418 * @returns the name of the selected Menu-Item 1419 1419 */ 1420 1420 char* Menu::save() … … 1437 1437 1438 1438 /** 1439 \briefloads a Menu from of its loadString1440 \param loadString the string from which to load the data from1439 * loads a Menu from of its loadString 1440 * @param loadString the string from which to load the data from 1441 1441 */ 1442 1442 void Menu::load(char* loadString) … … 1462 1462 1463 1463 /** 1464 \briefappends a new Item to the Menu-List.1465 \param itemName the itemName to be appendet.1464 * appends a new Item to the Menu-List. 1465 * @param itemName the itemName to be appendet. 1466 1466 */ 1467 1467 void Menu::addItem(char* itemName) … … 1490 1490 1491 1491 /** 1492 \briefRedraws the widget1492 * Redraws the widget 1493 1493 Example: see void CheckButton::redraw() 1494 1494 */ … … 1501 1501 1502 1502 /** 1503 \briefChanged the Option, call this Function1503 * Changed the Option, call this Function 1504 1504 */ 1505 1505 void Menu::changeOption() … … 1520 1520 1521 1521 /** 1522 \briefCreates a new OptionLabel with a LabelName and a Value.1523 \param label The name of the OptionLabel.1524 \param value The Value of the OptionLabel(what will be displayed).1522 * Creates a new OptionLabel with a LabelName and a Value. 1523 * @param label The name of the OptionLabel. 1524 * @param value The Value of the OptionLabel(what will be displayed). 1525 1525 */ 1526 1526 OptionLabel::OptionLabel(const char* label, const char* value) … … 1538 1538 1539 1539 /** 1540 \briefdestructs an OptionLabel.1540 * destructs an OptionLabel. 1541 1541 */ 1542 1542 OptionLabel::~OptionLabel() … … 1548 1548 1549 1549 /** 1550 \briefUpdates the value of an OptionLabel1551 \param newValue The new Name that should be displayed.1550 * Updates the value of an OptionLabel 1551 * @param newValue The new Name that should be displayed. 1552 1552 */ 1553 1553 void OptionLabel::setValue(const char* newValue) … … 1562 1562 1563 1563 /** 1564 \briefRedraws an OptionLabel(not implemented yet, but it works).1564 * Redraws an OptionLabel(not implemented yet, but it works). 1565 1565 */ 1566 1566 void OptionLabel::redraw() … … 1572 1572 1573 1573 /** 1574 \briefChanged the Option, call this Function1574 * Changed the Option, call this Function 1575 1575 */ 1576 1576 void OptionLabel::changeOption() … … 1589 1589 1590 1590 /** 1591 \briefcreates the Optionlabel save-string1592 \returns the String to save.1591 * creates the Optionlabel save-string 1592 * @returns the String to save. 1593 1593 */ 1594 1594 char* OptionLabel::save() … … 1598 1598 1599 1599 /** 1600 \briefloads an Option from of its loadString1601 \param loadString the string from which to load the data from1600 * loads an Option from of its loadString 1601 * @param loadString the string from which to load the data from 1602 1602 */ 1603 1603 void OptionLabel::load(char* loadString) … … 1611 1611 /////////// 1612 1612 /** 1613 \briefCreates a new Label with a Text.1614 \param text The text to be displayed.1613 * Creates a new Label with a Text. 1614 * @param text The text to be displayed. 1615 1615 */ 1616 1616 Label:: Label(const char* text) … … 1628 1628 1629 1629 /** 1630 \briefdestructs a Label.1630 * destructs a Label. 1631 1631 */ 1632 1632 Label::~Label() … … 1636 1636 1637 1637 /** 1638 \briefSets a new Text to a Label.1639 \param text The text to be inserted into the Label.1638 * Sets a new Text to a Label. 1639 * @param text The text to be inserted into the Label. 1640 1640 */ 1641 1641 void Label::setTitle(const char* text) … … 1651 1651 1652 1652 /** 1653 \briefereases the Text of a Label1653 * ereases the Text of a Label 1654 1654 */ 1655 1655 void Label::ereaseText() … … 1659 1659 1660 1660 /** 1661 \briefappends some Text to a Label1662 \param textToAppend The text that will be appended to this Label1661 * appends some Text to a Label 1662 * @param textToAppend The text that will be appended to this Label 1663 1663 */ 1664 1664 void Label::appendText(char* textToAppend) … … 1681 1681 1682 1682 /** 1683 \briefAppends some integer to the Label1684 \param intToAppend The Int that will be added.1683 * Appends some integer to the Label 1684 * @param intToAppend The Int that will be added. 1685 1685 1686 1686 it does this by just converting the int into a char* and send it to appendText … … 1695 1695 1696 1696 /** 1697 \briefget the Text of a Label1698 \return The Text the Label holds.1697 * get the Text of a Label 1698 * @return The Text the Label holds. 1699 1699 */ 1700 1700 const char* Label::getText() … … 1707 1707 ////////////////// 1708 1708 /** 1709 \briefCreates a new ProgressBar.1710 \param label The name you want to get the ProgressBar.1709 * Creates a new ProgressBar. 1710 * @param label The name you want to get the ProgressBar. 1711 1711 */ 1712 1712 ProgressBar::ProgressBar(const char* label) … … 1726 1726 1727 1727 /** 1728 \briefdestructs a ProgressBar1728 * destructs a ProgressBar 1729 1729 */ 1730 1730 ProgressBar::~ProgressBar() … … 1734 1734 1735 1735 /** 1736 \briefSets the Total size of the Bar.(ex. The maximum one can download)1736 * Sets the Total size of the Bar.(ex. The maximum one can download) 1737 1737 */ 1738 1738 void ProgressBar::setTotalSize(double totalSize) … … 1742 1742 1743 1743 /** 1744 \briefSets the progress maximum is this->totalSize1744 * Sets the progress maximum is this->totalSize 1745 1745 */ 1746 1746 void ProgressBar::setProgress(double progress) … … 1760 1760 1761 1761 /** 1762 \briefreturns the Progress Status1762 * returns the Progress Status 1763 1763 */ 1764 1764 double ProgressBar::getProgress() … … 1771 1771 /////////// 1772 1772 /** 1773 \briefCreates a new Image1774 \param imageName the location of the Image on the Hard Disc1773 * Creates a new Image 1774 * @param imageName the location of the Image on the Hard Disc 1775 1775 */ 1776 1776 Image::Image(const char* imageName) … … 1784 1784 1785 1785 /** 1786 \briefCreates a new Image1787 \param imageData data to the PixBuff1786 * Creates a new Image 1787 * @param imageData data to the PixBuff 1788 1788 */ 1789 1789 Image::Image(char** imageData) … … 1798 1798 1799 1799 /** 1800 \briefdestructs an Image.1800 * destructs an Image. 1801 1801 */ 1802 1802 Image::~Image() … … 1806 1806 1807 1807 /** 1808 \briefInitializes a new Image1809 \param name the name to set to the Image1808 * Initializes a new Image 1809 * @param name the name to set to the Image 1810 1810 */ 1811 1811 void Image::init(const char* name) … … 1824 1824 ///////////////// 1825 1825 /** 1826 \briefCreates a new FileDialog1827 \param fileDialogName a Name for the Dialog1826 * Creates a new FileDialog 1827 * @param fileDialogName a Name for the Dialog 1828 1828 */ 1829 1829 FileDialog::FileDialog(const char* fileDialogName) … … 1859 1859 1860 1860 /** 1861 \briefdestructs a FileDialog1861 * destructs a FileDialog 1862 1862 */ 1863 1863 FileDialog::~FileDialog() … … 1901 1901 1902 1902 /** 1903 \briefdisables the File Operator Buttons1903 * disables the File Operator Buttons 1904 1904 */ 1905 1905 void FileDialog::disableFileOpts() … … 1911 1911 1912 1912 /** 1913 \briefThe ok-button has been pressed1913 * The ok-button has been pressed 1914 1914 */ 1915 1915 void FileDialog::okEvent() -
orxonox/trunk/src/lib/gui/gui_gtk.h
r4746 r4836 122 122 123 123 void setGroupName(const char* name); 124 /** \returns the GroupName if existent NULL otherwise */124 /** @returns the GroupName if existent NULL otherwise */ 125 125 inline const char* getGroupName() const {return this->groupName;} 126 126 … … 364 364 virtual void changeOption(); 365 365 366 char* cValue; //!< The Value the Label will have. \todo make private366 char* cValue; //!< The Value the Label will have. @todo make private 367 367 }; 368 368 -
orxonox/trunk/src/lib/gui/gui_keys.cc
r4746 r4836 29 29 30 30 /** 31 \briefCreates an Keyboard-Frame31 * Creates an Keyboard-Frame 32 32 */ 33 33 GuiKeys::GuiKeys() … … 77 77 78 78 /** 79 \briefDestructs the Keys-stuff79 * Destructs the Keys-stuff 80 80 */ 81 81 GuiKeys::~GuiKeys() … … 93 93 //////////// 94 94 /** 95 \briefCreates new inputs for a player96 \param player the name of the Player95 * Creates new inputs for a player 96 * @param player the name of the Player 97 97 */ 98 98 PlayerKeys::PlayerKeys(char* player) … … 147 147 148 148 /** 149 \returns the OpenButton of a Player149 * @returns the OpenButton of a Player 150 150 */ 151 151 Button* PlayerKeys::getOpenButton() … … 158 158 ////////////////// 159 159 /** 160 \briefCreates new inputs for a misc161 \param player the name of the Misc160 * Creates new inputs for a misc 161 * @param player the name of the Misc 162 162 */ 163 163 MiscKeys::MiscKeys() … … 212 212 213 213 /** 214 \returns the OpenButton of a Misc214 * @returns the OpenButton of a Misc 215 215 */ 216 216 Button* MiscKeys::getOpenButton() … … 221 221 222 222 /** 223 \briefadds a new Key.224 \param key the number of the Key225 \param name The name of the new Key.226 \returns A widget that has the Key-Box223 * adds a new Key. 224 * @param key the number of the Key 225 * @param name The name of the new Key. 226 * @returns A widget that has the Key-Box 227 227 */ 228 228 Widget* addKey(const char* name, const char* defaultVal) … … 256 256 257 257 /** 258 \briefFunction which gets keystrokes259 \param w the widget that released the Function.260 \param event The event that happened.261 \param Widget the Widget which will be applied.262 \returns Nothing258 * Function which gets keystrokes 259 * @param w the widget that released the Function. 260 * @param event The event that happened. 261 * @param Widget the Widget which will be applied. 262 * @returns Nothing 263 263 */ 264 264 gint key_cb(GtkWidget* w, GdkEventKey* event, void* inputKey) -
orxonox/trunk/src/lib/gui/gui_update.cc
r4774 r4836 33 33 34 34 /** 35 \briefCreates an Update-Frame35 * Creates an Update-Frame 36 36 */ 37 37 GuiUpdate::GuiUpdate() … … 98 98 99 99 /** 100 \briefDestructs the Update-stuff100 * Destructs the Update-stuff 101 101 */ 102 102 GuiUpdate::~GuiUpdate() … … 106 106 107 107 /** 108 \briefchecks if the Folder containing selected File is data.oxd, and if so sets it.109 \param108 * checks if the Folder containing selected File is data.oxd, and if so sets it. 109 * @param 110 110 */ 111 111 bool GuiUpdate::checkDataDir(const char* fileName, void* object) … … 126 126 127 127 /** 128 \briefLook what info we can get from this system128 * Look what info we can get from this system 129 129 */ 130 130 bool GuiUpdate::getSystemInfo() … … 167 167 168 168 /** 169 \briefCreates a window, and all it contains for the Data-update.169 * Creates a window, and all it contains for the Data-update. 170 170 */ 171 171 void GuiUpdate::updateDataWindowCreate() … … 206 206 207 207 /** 208 \returns A Pointer to the Button of the UpdaterDataWindow208 * @returns A Pointer to the Button of the UpdaterDataWindow 209 209 */ 210 210 Button* GuiUpdate::updateDataWindowGetButton() … … 214 214 215 215 /** 216 \briefCreates a window, and all it contains for the Source-update.216 * Creates a window, and all it contains for the Source-update. 217 217 */ 218 218 void GuiUpdate::updateSourceWindowCreate() … … 245 245 246 246 /** 247 \returns A Pointer to the Button of the UpdaterSourceWindow247 * @returns A Pointer to the Button of the UpdaterSourceWindow 248 248 */ 249 249 Button* GuiUpdate::updateSourceWindowGetButton() … … 255 255 #ifdef HAVE_GTK2 256 256 /** 257 \briefupdates the Data of orxonox.258 \param w The widget, that executed this Function.259 \param event The event that trigered this Function.260 \param button The Button, that triggered this event.257 * updates the Data of orxonox. 258 * @param w The widget, that executed this Function. 259 * @param event The event that trigered this Function. 260 * @param button The Button, that triggered this event. 261 261 */ 262 262 gint GuiUpdate::updateDataFunc(GtkWidget* w, GdkEventKey* event, void* info) … … 272 272 273 273 /** 274 \briefupdates the source of orxonox.275 \param w The widget, that executed this Function.276 \param event The event that trigered this Function.277 \param button The Button, that triggered this event.274 * updates the source of orxonox. 275 * @param w The widget, that executed this Function. 276 * @param event The event that trigered this Function. 277 * @param button The Button, that triggered this event. 278 278 */ 279 279 gint GuiUpdate::updateSourceFunc(GtkWidget* w, GdkEventKey* event, void* bar) … … 286 286 287 287 /** 288 \briefThe Function Curl calls to write out the File.289 \param ptr A Pointer to the date to write.290 \param size The size in bytes of one nmemb to write.291 \param nmemb The Count of size to write.292 \param stream Filehandler to write to.288 * The Function Curl calls to write out the File. 289 * @param ptr A Pointer to the date to write. 290 * @param size The size in bytes of one nmemb to write. 291 * @param nmemb The Count of size to write. 292 * @param stream Filehandler to write to. 293 293 */ 294 294 size_t GuiUpdate::curlWriteFunc(void* ptr, size_t size, size_t nmemb, FILE* stream) … … 298 298 299 299 /** 300 \briefThe Function Curl calls to write out the File.301 \param ptr A Pointer to the date to write to.302 \param size The size in bytes of one nmemb to write.303 \param nmemb The Count of size to write.304 \param stream Filehandler to get data from.300 * The Function Curl calls to write out the File. 301 * @param ptr A Pointer to the date to write to. 302 * @param size The size in bytes of one nmemb to write. 303 * @param nmemb The Count of size to write. 304 * @param stream Filehandler to get data from. 305 305 */ 306 306 size_t GuiUpdate::curlReadFunc(void* ptr, size_t size, size_t nmemb, FILE* stream) … … 311 311 312 312 /** 313 \briefAn update Function for the GUI, to show the progress.314 \param Bar th ProgressBar to update315 \param totalSize The total size of the download in bytes.316 \param progress The current Progress of the download in bytes.317 \param upTotal not needed318 \param upProgress not needed313 * An update Function for the GUI, to show the progress. 314 * @param Bar th ProgressBar to update 315 * @param totalSize The total size of the download in bytes. 316 * @param progress The current Progress of the download in bytes. 317 * @param upTotal not needed 318 * @param upProgress not needed 319 319 */ 320 320 int GuiUpdate::curlProgressFunc(ProgressBar* bar, double totalSize, double progress, double upTotal, double upProgress) … … 329 329 330 330 /** 331 \briefThe Curl handle for only one CURL(static).331 * The Curl handle for only one CURL(static). 332 332 */ 333 333 CURL* GuiUpdate::curlHandle = NULL; … … 340 340 341 341 /** 342 \briefInitializes a Download without displaying it.343 \param fileInfo the FileInfo.342 * Initializes a Download without displaying it. 343 * @param fileInfo the FileInfo. 344 344 345 345 !! BE AWARE THIS WILL NOT BE THREADED. !! … … 359 359 char* fileOnNet = new char [strlen(info->webRoot)+strlen(info->fileName)+2]; 360 360 strcpy(fileOnNet, info->webRoot); 361 if(fileOnNet[strlen(fileOnNet)] != '/') //!< \todo windows-shit361 if(fileOnNet[strlen(fileOnNet)] != '/') //!< @todo windows-shit 362 362 strcat(fileOnNet, "/"); 363 363 strcat(fileOnNet, info->fileName); 364 364 char* fileOnDisk = new char [strlen(info->localRoot)+strlen(info->fileName)+2]; 365 365 strcpy(fileOnDisk, info->localRoot); 366 if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< \todo windows-shit366 if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< @todo windows-shit 367 367 strcat(fileOnDisk, "/"); 368 368 strcat(fileOnDisk, info->fileName); … … 387 387 388 388 /** 389 \briefInitializes a Download with some style.390 \param fileInfo the FileInfo.391 \todo release thread-lock.389 * Initializes a Download with some style. 390 * @param fileInfo the FileInfo. 391 @todo release thread-lock. 392 392 393 393 Downloading with a Button that gets a different Name while downloading, and a Bar, that gets to be updated. More to be followed … … 447 447 448 448 /** 449 \briefThe downloading process(either threaded or not).450 \param fileInfo the FileInfo.451 452 \todo Threads get locked, if the cancel button is pressed in to small intervals.449 * The downloading process(either threaded or not). 450 * @param fileInfo the FileInfo. 451 452 @todo Threads get locked, if the cancel button is pressed in to small intervals. 453 453 */ 454 454 void* GuiUpdate::downloadThread(void* fileInfo) … … 459 459 460 460 /** 461 \briefFinishes a downloading process.462 \param fileInfo the FileInfo.461 * Finishes a downloading process. 462 * @param fileInfo the FileInfo. 463 463 */ 464 464 void* GuiUpdate::downloadThreadFinished(void* fileInfo) … … 485 485 #ifdef HAVE_GTK2 486 486 /** 487 \briefcanceles a downloading session.488 \param w The widget, that executed this Function.489 \param event The event that trigered this Function.490 \param bar The Bar, that triggered this event.491 492 \todo canceling a session in non-threaded mode.487 * canceles a downloading session. 488 * @param w The widget, that executed this Function. 489 * @param event The event that trigered this Function. 490 * @param bar The Bar, that triggered this event. 491 492 @todo canceling a session in non-threaded mode. 493 493 */ 494 494 gint GuiUpdate::cancelDownload(GtkWidget* w, GdkEventKey* event, void* bar) -
orxonox/trunk/src/lib/gui/gui_update.h
r4746 r4836 51 51 Button* updateDataBegin; //!< A Button to start the process. 52 52 53 Button* updateSourceWindowButton; //!< A Button to update the Source of orxonox. \todo tricky53 Button* updateSourceWindowButton; //!< A Button to update the Source of orxonox. @todo tricky 54 54 Window* updateSourceWindow; //!< A Window for the Source-update. 55 55 Box* updateSourceBox; //!< A Box for the Window for the Source-update. -
orxonox/trunk/src/lib/gui/gui_video.cc
r4777 r4836 32 32 33 33 /** 34 \briefCreates the Video-Option-Frame34 * Creates the Video-Option-Frame 35 35 */ 36 36 GuiVideo::GuiVideo() … … 74 74 75 75 /** 76 \briefDestructs the Video-stuff76 * Destructs the Video-stuff 77 77 */ 78 78 GuiVideo::~GuiVideo() … … 82 82 83 83 /** 84 \briefCreates a window, and all it contains for the Source-update.84 * Creates a window, and all it contains for the Source-update. 85 85 */ 86 86 Widget* GuiVideo::advancedWindowCreate() … … 185 185 186 186 /** 187 \briefsets all resolutions to the menu188 \param menu the Menu to set The resolutions to.187 * sets all resolutions to the menu 188 * @param menu the Menu to set The resolutions to. 189 189 */ 190 190 void GuiVideo::getResolutions(Menu* menu) -
orxonox/trunk/src/lib/lang/base_object.cc
r4815 r4836 27 27 28 28 /** 29 \briefsets the name from a LoadXML-Element30 \param root the element to load from29 * sets the name from a LoadXML-Element 30 * @param root the element to load from 31 31 */ 32 32 BaseObject::BaseObject(const TiXmlElement* root) … … 45 45 46 46 /** 47 \briefstandard deconstructor47 * standard deconstructor 48 48 */ 49 49 BaseObject::~BaseObject () … … 56 56 57 57 /** 58 \briefloads parameters59 \param root the element to load from58 * loads parameters 59 * @param root the element to load from 60 60 */ 61 61 void BaseObject::loadParams(const TiXmlElement* root) … … 67 67 68 68 /** 69 \briefsets the class identifiers70 \param id a number for the class from class_id.h enumeration71 \param className the class name69 * sets the class identifiers 70 * @param id a number for the class from class_id.h enumeration 71 * @param className the class name 72 72 */ 73 73 void BaseObject::setClassID(long classID, const char* className) … … 97 97 98 98 /** 99 \briefchecks if the class is a classID100 \param classID the Identifier to check for101 \returns true if it is, false otherwise99 * checks if the class is a classID 100 * @param classID the Identifier to check for 101 * @returns true if it is, false otherwise 102 102 */ 103 103 bool BaseObject::isA (long classID) const … … 118 118 119 119 /** 120 * @briefdisplays everything this class is120 * displays everything this class is 121 121 */ 122 122 void BaseObject::whatIs() const -
orxonox/trunk/src/lib/lang/base_object.h
r4747 r4836 1 1 /*! 2 2 \file base_object.h 3 \briefDefinition of the base object class.3 * Definition of the base object class. 4 4 5 5 This is a global handler for all classes. … … 30 30 inline const char* getName ()const { return this->objectName; }; 31 31 32 /** \returns the className of the corresponding Object */32 /** @returns the className of the corresponding Object */ 33 33 inline const char* getClassName() const { return this->className; }; 34 /** \returns the classID of the corresponding Object */34 /** @returns the classID of the corresponding Object */ 35 35 inline int getClassID() const { return this->classID; } 36 36 … … 38 38 void whatIs() const; 39 39 40 /** \returns if the object is finalized */40 /** @returns if the object is finalized */ 41 41 inline bool isFinalized() { return this->finalized; } 42 42 -
orxonox/trunk/src/lib/lang/class_list.cc
r4815 r4836 29 29 30 30 /** 31 \briefCreates a new ClassList31 * Creates a new ClassList 32 32 */ 33 33 ClassList::ClassList(const long& classID, const char* className) … … 43 43 44 44 /** 45 \briefstandard deconstructor45 * standard deconstructor 46 46 */ 47 47 ClassList::~ClassList () -
orxonox/trunk/src/lib/lang/class_list.h
r4782 r4836 1 1 /*! 2 2 \file class_list.h 3 \briefDefinition of the Class List, that handles a Class-Specific-Control structure3 * Definition of the Class List, that handles a Class-Specific-Control structure 4 4 5 5 */ -
orxonox/trunk/src/lib/math/curve.cc
r4746 r4836 34 34 35 35 /** 36 \briefdefault constructor for a Curve36 * default constructor for a Curve 37 37 */ 38 38 Curve::Curve() … … 48 48 49 49 /** 50 \briefadds a new Node to the bezier Curve51 \param newNode a Vector to the position of the new node50 * adds a new Node to the bezier Curve 51 * @param newNode a Vector to the position of the new node 52 52 */ 53 53 void Curve::addNode(const Vector& newNode) … … 65 65 66 66 /** 67 \briefadds a new Node to the bezier Curve68 \param newNode a Vector to the position of the new node69 \param insertPosition after the n-th node the new node will be inserted67 * adds a new Node to the bezier Curve 68 * @param newNode a Vector to the position of the new node 69 * @param insertPosition after the n-th node the new node will be inserted 70 70 */ 71 71 void Curve::addNode(const Vector& newNode, unsigned int insertPosition) … … 111 111 112 112 /** 113 \briefFinds a Node by its Number, and returns its Position114 \param nodeToFind the n'th node in the List of nodes115 \returns A Vector to the Position of the Node.113 * Finds a Node by its Number, and returns its Position 114 * @param nodeToFind the n'th node in the List of nodes 115 * @returns A Vector to the Position of the Node. 116 116 */ 117 117 Vector Curve::getNode(unsigned int nodeToFind) … … 126 126 127 127 /** 128 \briefOutputs information about the state of this Curve128 * Outputs information about the state of this Curve 129 129 */ 130 130 void Curve::debug() … … 148 148 149 149 /** 150 \briefCreates a new BezierCurve150 * Creates a new BezierCurve 151 151 */ 152 152 BezierCurve::BezierCurve () … … 157 157 158 158 /** 159 \briefCreates a new BezierCurve-Derivation-Curve159 * Creates a new BezierCurve-Derivation-Curve 160 160 */ 161 161 BezierCurve::BezierCurve (int derivation) … … 166 166 167 167 /** 168 \briefDeletes a BezierCurve.168 * Deletes a BezierCurve. 169 169 170 170 It does this by freeing all the space taken over from the nodes … … 185 185 186 186 /** 187 \briefRebuilds a Curve187 * Rebuilds a Curve 188 188 */ 189 189 void BezierCurve::rebuild() … … 225 225 226 226 /** 227 \briefcalculates the Position on the curve228 \param t The position on the Curve (0<=t<=1)229 \return the Position on the Path227 * calculates the Position on the curve 228 * @param t The position on the Curve (0<=t<=1) 229 * @return the Position on the Path 230 230 */ 231 231 Vector BezierCurve::calcPos(float t) … … 257 257 258 258 /** 259 \briefCalulates the direction of the Curve at time t.260 \param t The time at which to evaluate the curve.261 \returns The valuated Vector.259 * Calulates the direction of the Curve at time t. 260 * @param t The time at which to evaluate the curve. 261 * @returns The valuated Vector. 262 262 */ 263 263 Vector BezierCurve::calcDir (float t) … … 267 267 268 268 /** 269 \briefCalulates the acceleration (second derivate) of the Curve at time t.270 \param t The time at which to evaluate the curve.271 \returns The valuated Vector.269 * Calulates the acceleration (second derivate) of the Curve at time t. 270 * @param t The time at which to evaluate the curve. 271 * @returns The valuated Vector. 272 272 */ 273 273 Vector BezierCurve::calcAcc (float t) … … 277 277 278 278 /** 279 \briefCalculates the Quaternion needed for our rotations280 \param t The time at which to evaluate the cuve.281 \returns The evaluated Quaternion.279 * Calculates the Quaternion needed for our rotations 280 * @param t The time at which to evaluate the cuve. 281 * @returns The evaluated Quaternion. 282 282 */ 283 283 Quaternion BezierCurve::calcQuat (float t) -
orxonox/trunk/src/lib/math/curve.h
r4746 r4836 2 2 /*! 3 3 \file curve.h 4 \briefA basic 3D curve framework4 * A basic 3D curve framework 5 5 6 6 Contains classes to handle curves … … 36 36 void addNode(const Vector& newNode, unsigned int insertPosition); 37 37 Vector getNode(unsigned int nodeToFind); 38 /** \returns the count of nodes in this curve */38 /** @returns the count of nodes in this curve */ 39 39 inline int getNodeCount() const { return this->nodeCount; }; 40 /** \returns the directional Curve */40 /** @returns the directional Curve */ 41 41 Curve* getDirCurve() const { return this->dirCurve; }; 42 42 43 /** \param t the value on the curve [0-1] \returns Vector to the position */43 /** @param t the value on the curve [0-1] @returns Vector to the position */ 44 44 virtual Vector calcPos(float t) = 0; 45 /** \param t the value on the curve [0-1] \returns the direction */45 /** @param t the value on the curve [0-1] @returns the direction */ 46 46 virtual Vector calcDir(float t) = 0; 47 /** \param t the value on the curve [0-1] \returns the acceleration */47 /** @param t the value on the curve [0-1] @returns the acceleration */ 48 48 virtual Vector calcAcc(float t) = 0; 49 /** \param t the value on the curve [0-1] \returns quaternion of the rotation */49 /** @param t the value on the curve [0-1] @returns quaternion of the rotation */ 50 50 virtual Quaternion calcQuat(float t) = 0; 51 51 -
orxonox/trunk/src/lib/math/vector.cc
r4746 r4836 28 28 ///////////// 29 29 /** 30 \briefreturns the this-vector normalized to length 1.030 * returns the this-vector normalized to length 1.0 31 31 */ 32 32 Vector Vector::getNormalized() const … … 46 46 47 47 /** 48 \briefVector is looking in the positive direction on all axes after this48 * Vector is looking in the positive direction on all axes after this 49 49 */ 50 50 Vector Vector::abs() … … 57 57 58 58 /** 59 \briefOutputs the values of the Vector59 * Outputs the values of the Vector 60 60 */ 61 61 void Vector::debug() const … … 71 71 ///////////////// 72 72 /** 73 \briefcalculates a lookAt rotation74 \param dir: the direction you want to look75 \param up: specify what direction up should be73 * calculates a lookAt rotation 74 * @param dir: the direction you want to look 75 * @param up: specify what direction up should be 76 76 77 77 Mathematically this determines the rotation a (0,0,1)-Vector has to undergo to point … … 112 112 113 113 /** 114 \briefcalculates a rotation from euler angles115 \param roll: the roll in radians116 \param pitch: the pitch in radians117 \param yaw: the yaw in radians114 * calculates a rotation from euler angles 115 * @param roll: the roll in radians 116 * @param pitch: the pitch in radians 117 * @param yaw: the yaw in radians 118 118 */ 119 119 Quaternion::Quaternion (float roll, float pitch, float yaw) … … 140 140 141 141 /** 142 \briefrotates one Quaternion by another143 \param q: another Quaternion to rotate this by144 \return a quaternion that represents the first one rotated by the second one (WARUNING: this operation is not commutative! e.g. (A*B) != (B*A))142 * rotates one Quaternion by another 143 * @param q: another Quaternion to rotate this by 144 * @return a quaternion that represents the first one rotated by the second one (WARUNING: this operation is not commutative! e.g. (A*B) != (B*A)) 145 145 */ 146 146 Quaternion Quaternion::operator*(const Quaternion& q) const … … 167 167 168 168 /** 169 \briefrotate a Vector by a Quaternion170 \param v: the Vector171 \return a new Vector representing v rotated by the Quaternion169 * rotate a Vector by a Quaternion 170 * @param v: the Vector 171 * @return a new Vector representing v rotated by the Quaternion 172 172 */ 173 173 … … 183 183 184 184 /** 185 \briefmultiply a Quaternion with a real value186 \param f: a real value187 \return a new Quaternion containing the product185 * multiply a Quaternion with a real value 186 * @param f: a real value 187 * @return a new Quaternion containing the product 188 188 */ 189 189 Quaternion Quaternion::operator*(const float& f) const … … 196 196 197 197 /** 198 \briefdivide a Quaternion by a real value199 \param f: a real value200 \return a new Quaternion containing the quotient198 * divide a Quaternion by a real value 199 * @param f: a real value 200 * @return a new Quaternion containing the quotient 201 201 */ 202 202 Quaternion Quaternion::operator/(const float& f) const … … 210 210 211 211 /** 212 \briefcalculate the conjugate value of the Quaternion213 \return the conjugate Quaternion212 * calculate the conjugate value of the Quaternion 213 * @return the conjugate Quaternion 214 214 */ 215 215 /* … … 223 223 224 224 /** 225 \briefcalculate the norm of the Quaternion226 \return the norm of The Quaternion225 * calculate the norm of the Quaternion 226 * @return the norm of The Quaternion 227 227 */ 228 228 float Quaternion::norm() const … … 232 232 233 233 /** 234 \briefcalculate the inverse value of the Quaternion235 \return the inverse Quaternion234 * calculate the inverse value of the Quaternion 235 * @return the inverse Quaternion 236 236 237 237 Note that this is equal to conjugate() if the Quaternion's norm is 1 … … 248 248 249 249 /** 250 \briefconvert the Quaternion to a 4x4 rotational glMatrix251 \param m: a buffer to store the Matrix in250 * convert the Quaternion to a 4x4 rotational glMatrix 251 * @param m: a buffer to store the Matrix in 252 252 */ 253 253 void Quaternion::matrix (float m[4][4]) const … … 277 277 278 278 /** 279 \briefperforms a smooth move.280 \param from where281 \param to where282 \param t the time this transformation should take value [0..1]283 284 \returns the Result of the smooth move279 * performs a smooth move. 280 * @param from where 281 * @param to where 282 * @param t the time this transformation should take value [0..1] 283 284 * @returns the Result of the smooth move 285 285 */ 286 286 Quaternion quatSlerp(const Quaternion& from, const Quaternion& to, float t) … … 339 339 340 340 /** 341 \briefconvert a rotational 4x4 glMatrix into a Quaternion342 \param m: a 4x4 matrix in glMatrix order341 * convert a rotational 4x4 glMatrix into a Quaternion 342 * @param m: a 4x4 matrix in glMatrix order 343 343 */ 344 344 Quaternion::Quaternion (float m[4][4]) … … 389 389 390 390 /** 391 \briefoutputs some nice formated debug information about this quaternion391 * outputs some nice formated debug information about this quaternion 392 392 */ 393 393 void Quaternion::debug() … … 398 398 399 399 /** 400 \briefcreate a rotation from a vector401 \param v: a vector400 * create a rotation from a vector 401 * @param v: a vector 402 402 */ 403 403 Rotation::Rotation (const Vector& v) … … 421 421 422 422 /** 423 \briefcreates a rotation from an axis and an angle (radians!)424 \param axis: the rotational axis425 \param angle: the angle in radians423 * creates a rotation from an axis and an angle (radians!) 424 * @param axis: the rotational axis 425 * @param angle: the angle in radians 426 426 */ 427 427 Rotation::Rotation (const Vector& axis, float angle) … … 442 442 443 443 /** 444 \briefcreates a rotation from euler angles (pitch/yaw/roll)445 \param pitch: rotation around z (in radians)446 \param yaw: rotation around y (in radians)447 \param roll: rotation around x (in radians)444 * creates a rotation from euler angles (pitch/yaw/roll) 445 * @param pitch: rotation around z (in radians) 446 * @param yaw: rotation around y (in radians) 447 * @param roll: rotation around x (in radians) 448 448 */ 449 449 Rotation::Rotation ( float pitch, float yaw, float roll) … … 468 468 469 469 /** 470 \briefcreates a nullrotation (an identity rotation)470 * creates a nullrotation (an identity rotation) 471 471 */ 472 472 Rotation::Rotation () … … 484 484 485 485 /** 486 \brieffills the specified buffer with a 4x4 glmatrix487 \param buffer: Pointer to an array of 16 floats486 * fills the specified buffer with a 4x4 glmatrix 487 * @param buffer: Pointer to an array of 16 floats 488 488 489 489 Use this to get the rotation in a gl-compatible format … … 510 510 511 511 /** 512 \briefmultiplies two rotational matrices513 \param r: another Rotation514 \return the matrix product of the Rotations512 * multiplies two rotational matrices 513 * @param r: another Rotation 514 * @return the matrix product of the Rotations 515 515 516 516 Use this to rotate one rotation by another … … 537 537 538 538 /** 539 \briefrotates the vector by the given rotation540 \param v: a vector541 \param r: a rotation542 \return the rotated vector539 * rotates the vector by the given rotation 540 * @param v: a vector 541 * @param r: a rotation 542 * @return the rotated vector 543 543 */ 544 544 Vector rotateVector( const Vector& v, const Rotation& r) … … 554 554 555 555 /** 556 \briefcalculate the distance between two lines557 \param l: the other line558 \return the distance between the lines556 * calculate the distance between two lines 557 * @param l: the other line 558 * @return the distance between the lines 559 559 */ 560 560 float Line::distance (const Line& l) const … … 569 569 570 570 /** 571 \briefcalculate the distance between a line and a point572 \param v: the point573 \return the distance between the Line and the point571 * calculate the distance between a line and a point 572 * @param v: the point 573 * @return the distance between the Line and the point 574 574 */ 575 575 float Line::distancePoint (const Vector& v) const … … 581 581 582 582 /** 583 \briefcalculate the distance between a line and a point584 \param v: the point585 \return the distance between the Line and the point583 * calculate the distance between a line and a point 584 * @param v: the point 585 * @return the distance between the Line and the point 586 586 */ 587 587 float Line::distancePoint (const sVec3D& v) const … … 594 594 595 595 /** 596 \briefcalculate the two points of minimal distance of two lines597 \param l: the other line598 \return a Vector[2] (!has to be deleted after use!) containing the two points of minimal distance596 * calculate the two points of minimal distance of two lines 597 * @param l: the other line 598 * @return a Vector[2] (!has to be deleted after use!) containing the two points of minimal distance 599 599 */ 600 600 Vector* Line::footpoints (const Line& l) const … … 618 618 619 619 /** 620 \briefrotate the line by given rotation621 \param rot: a rotation620 * rotate the line by given rotation 621 * @param rot: a rotation 622 622 */ 623 623 void Line::rotate (const Rotation& rot) … … 630 630 631 631 /** 632 \briefcreate a plane from three points633 \param a: first point634 \param b: second point635 \param c: third point632 * create a plane from three points 633 * @param a: first point 634 * @param b: second point 635 * @param c: third point 636 636 */ 637 637 Plane::Plane (Vector a, Vector b, Vector c) … … 642 642 643 643 /** 644 \briefcreate a plane from anchor point and normal645 \param norm: normal vector646 \param p: anchor point644 * create a plane from anchor point and normal 645 * @param norm: normal vector 646 * @param p: anchor point 647 647 */ 648 648 Plane::Plane (Vector norm, Vector p) … … 654 654 655 655 /** 656 \briefcreate a plane from anchor point and normal657 \param norm: normal vector658 \param p: anchor point656 * create a plane from anchor point and normal 657 * @param norm: normal vector 658 * @param p: anchor point 659 659 */ 660 660 Plane::Plane (Vector norm, sVec3D g) … … 667 667 668 668 /** 669 \briefreturns the intersection point between the plane and a line670 \param l: a line669 * returns the intersection point between the plane and a line 670 * @param l: a line 671 671 */ 672 672 Vector Plane::intersectLine (const Line& l) const … … 678 678 679 679 /** 680 \briefreturns the distance between the plane and a point681 \param p: a Point682 \return the distance between the plane and the point (can be negative)680 * returns the distance between the plane and a point 681 * @param p: a Point 682 * @return the distance between the plane and the point (can be negative) 683 683 */ 684 684 float Plane::distancePoint (const Vector& p) const … … 691 691 692 692 /** 693 \briefreturns the distance between the plane and a point694 \param p: a Point695 \return the distance between the plane and the point (can be negative)693 * returns the distance between the plane and a point 694 * @param p: a Point 695 * @return the distance between the plane and the point (can be negative) 696 696 */ 697 697 float Plane::distancePoint (const sVec3D& p) const … … 705 705 706 706 /** 707 \briefreturns the side a point is located relative to a Plane708 \param p: a Point709 \return 0 if the point is contained within the Plane, positive(negative) if the point is in the positive(negative) semi-space of the Plane707 * returns the side a point is located relative to a Plane 708 * @param p: a Point 709 * @return 0 if the point is contained within the Plane, positive(negative) if the point is in the positive(negative) semi-space of the Plane 710 710 */ 711 711 float Plane::locatePoint (const Vector& p) const -
orxonox/trunk/src/lib/math/vector.h
r4611 r4836 1 1 /*! 2 2 \file vector.h 3 \briefA basic 3D math framework3 * A basic 3D math framework 4 4 5 5 Contains classes to handle vectors, lines, rotations and planes … … 27 27 ~Vector () {} 28 28 29 /** \param index The index of the "array" \returns the x/y/z coordinate */29 /** @param index The index of the "array" @returns the x/y/z coordinate */ 30 30 inline float operator[] (float index) const {if( index == 0) return this->x; if( index == 1) return this->y; if( index == 2) return this->z; } 31 /** \param v The vector to add \returns the addition between two vectors (this + v) */31 /*** @param v The vector to add @returns the addition between two vectors (this + v) */ 32 32 inline Vector operator+ (const Vector& v) const { return Vector(x + v.x, y + v.y, z + v.z); }; 33 /** \param v The vector to add \returns the addition between two vectors (this + v) */33 /*** @param v The vector to add @returns the addition between two vectors (this + v) */ 34 34 inline Vector operator+ (const sVec3D& v) const { return Vector(x + v[0], y + v[1], z + v[2]); }; 35 /** \param v The vector to add \returns the addition between two vectors (this += v) */35 /** @param v The vector to add @returns the addition between two vectors (this += v) */ 36 36 inline const Vector& operator+= (const Vector& v) { this->x += v.x; this->y += v.y; this->z += v.z; return *this; }; 37 /** \param v The vector to substract \returns the substraction between two vectors (this - v) */37 /** @param v The vector to substract @returns the substraction between two vectors (this - v) */ 38 38 inline const Vector& operator+= (const sVec3D& v) { this->x += v[0]; this->y += v[1]; this->z += v[2]; return *this; }; 39 /** \param v The vector to substract \returns the substraction between two vectors (this - v) */39 /** @param v The vector to substract @returns the substraction between two vectors (this - v) */ 40 40 inline Vector operator- (const Vector& v) const { return Vector(x - v.x, y - v.y, z - v.z); } 41 /** \param v The vector to substract \returns the substraction between two vectors (this - v) */41 /** @param v The vector to substract @returns the substraction between two vectors (this - v) */ 42 42 inline Vector operator- (const sVec3D& v) const { return Vector(x - v[0], y - v[1], z - v[2]); } 43 /** \param v The vector to substract \returns the substraction between two vectors (this -= v) */43 /** @param v The vector to substract @returns the substraction between two vectors (this -= v) */ 44 44 inline const Vector& operator-= (const Vector& v) { this->x -= v.x; this->y -= v.y; this->z -= v.z; return *this; }; 45 /** \param v The vector to substract \returns the substraction between two vectors (this -= v) */45 /** @param v The vector to substract @returns the substraction between two vectors (this -= v) */ 46 46 inline const Vector& operator-= (const sVec3D& v) { this->x -= v[0]; this->y -= v[1]; this->z -= v[2]; return *this; }; 47 /** \param v the second vector \returns The dotProduct between two vector (this (dot) v) */47 /** @param v the second vector @returns The dotProduct between two vector (this (dot) v) */ 48 48 inline float operator* (const Vector& v) const { return x * v.x + y * v.y + z * v.z; }; 49 /** \todo strange */49 /** @todo strange */ 50 50 inline const Vector& operator*= (const Vector& v) { this->x *= v.x; this->y *= v.y; this->z *= v.z; return *this; }; 51 /** \param f a factor to multiply the vector with \returns the vector multiplied by f (this * f) */51 /** @param f a factor to multiply the vector with @returns the vector multiplied by f (this * f) */ 52 52 inline Vector operator* (float f) const { return Vector(x * f, y * f, z * f); }; 53 /** \param f a factor to multiply the vector with \returns the vector multiplied by f (this *= f) */53 /** @param f a factor to multiply the vector with @returns the vector multiplied by f (this *= f) */ 54 54 inline const Vector& operator*= (float f) { this->x *= f; this->y *= f; this->z *= f; return *this; }; 55 /** \param f a factor to divide the vector with \returns the vector divided by f (this / f) */55 /** @param f a factor to divide the vector with @returns the vector divided by f (this / f) */ 56 56 inline Vector operator/ (float f) const {if (unlikely(f == 0.0)) return Vector(0,0,0); else return Vector(this->x / f, this->y / f, this->z / f); }; 57 /** \param f a factor to divide the vector with \returns the vector divided by f (this /= f) */57 /** @param f a factor to divide the vector with @returns the vector divided by f (this /= f) */ 58 58 inline const Vector& operator/= (float f) {if (unlikely(f == 0.0)) {this->x=0;this->y=0;this->z=0;} else {this->x /= f; this->y /= f; this->z /= f;} return *this; }; 59 /** \brief copy constructor \todo (i do not know it this is faster) \param v the vector to assign to this vector. \returns the vector v */59 /** \brief copy constructor @todo (i do not know it this is faster) @param v the vector to assign to this vector. @returns the vector v */ 60 60 inline const Vector& operator= (const Vector& v) { this->x = v.x; this->y = v.y; this->z = v.z; return *this; }; 61 /** \brief copy constructor \param v the sVec3D to assign to this vector. \returns the vector v */61 /** \brief copy constructor* @param v the sVec3D to assign to this vector. @returns the vector v */ 62 62 inline const Vector& operator= (const sVec3D& v) { this->x = v[0]; this->y = v[1]; this->z = v[2]; } 63 /** \param v: the other vector \return the dot product of the vectors */63 /** @param v: the other vector \return the dot product of the vectors */ 64 64 float dot (const Vector& v) const { return x*v.x+y*v.y+z*v.z; }; 65 /** \param v: the corss-product partner \returns the cross-product between this and v (this (x) v) */65 /** @param v: the corss-product partner @returns the cross-product between this and v (this (x) v) */ 66 66 inline Vector cross (const Vector& v) const { return Vector(y * v.z - z * v.y, z * v.x - x * v.z, x * v.y - y * v.x ); } 67 /** \brief scales the this vector with v \param v the vector to scale this with */67 /** \brief scales the this vector with v* @param v the vector to scale this with */ 68 68 void scale(const Vector& v) { x *= v.x; y *= v.y; z *= v.z; }; 69 /** \returns the length of the vector */69 /** @returns the length of the vector */ 70 70 inline float len() const { return sqrt (x*x+y*y+z*z); } 71 71 /** \brief normalizes the vector */ … … 93 93 94 94 /** 95 \briefcalculate the angle between two vectors in radiances96 \param v1: a vector97 \param v2: another vector98 \return the angle between the vectors in radians95 * calculate the angle between two vectors in radiances 96 * @param v1: a vector 97 * @param v2: another vector 98 * @return the angle between the vectors in radians 99 99 */ 100 100 inline float angleDeg (const Vector& v1, const Vector& v2) { return acos( v1 * v2 / (v1.len() * v2.len())); }; 101 101 /** 102 \briefcalculate the angle between two vectors in degrees103 \param v1: a vector104 \param v2: another vector105 \return the angle between the vectors in degrees102 * calculate the angle between two vectors in degrees 103 * @param v1: a vector 104 * @param v2: another vector 105 * @return the angle between the vectors in degrees 106 106 */ 107 107 inline float angleRad (const Vector& v1, const Vector& v2) { return acos( v1 * v2 / (v1.len() * v2.len())) * 180/M_PI; }; … … 117 117 /** \brief creates a Default quaternion (multiplicational identity Quaternion)*/ 118 118 inline Quaternion () { w = 1; v = Vector(0,0,0); } 119 /** \brief creates a Quaternion looking into the direction v \param v: the direction \param f: the value */119 /** \brief creates a Quaternion looking into the direction v @param v: the direction @param f: the value */ 120 120 inline Quaternion (const Vector& v, float f) { this->w = f; this->v = v; } 121 121 Quaternion (float m[4][4]); 122 /** \brief turns a rotation along an axis into a Quaternion \param angle: the amount of radians to rotate \param axis: the axis to rotate around */122 /** \brief turns a rotation along an axis into a Quaternion @param angle: the amount of radians to rotate @param axis: the axis to rotate around */ 123 123 inline Quaternion (float angle, const Vector& axis) { w = cos(angle/2); v = axis * sin(angle/2); } 124 124 Quaternion (const Vector& dir, const Vector& up); 125 125 Quaternion (float roll, float pitch, float yaw); 126 126 Quaternion operator/ (const float& f) const; 127 /** \param f: the value to divide by \returns the quaternion devided by f (this /= f) */127 /** @param f: the value to divide by @returns the quaternion devided by f (this /= f) */ 128 128 inline const Quaternion& operator/= (const float& f) {*this = *this / f; return *this;} 129 129 Quaternion operator* (const float& f) const; 130 /** \param f: the value to multiply by \returns the quaternion multiplied by f (this *= f) */130 /** @param f: the value to multiply by @returns the quaternion multiplied by f (this *= f) */ 131 131 inline const Quaternion& operator*= (const float& f) {*this = *this * f; return *this;} 132 132 Quaternion operator* (const Quaternion& q) const; 133 /** \param q: the Quaternion to multiply by \returns the quaternion multiplied by q (this *= q) */133 /** @param q: the Quaternion to multiply by @returns the quaternion multiplied by q (this *= q) */ 134 134 inline const Quaternion operator*= (const Quaternion& q) {*this = *this * q; return *this; }; 135 /** \param q the Quaternion to add to this \returns the quaternion added with q (this + q) */135 /** @param q the Quaternion to add to this @returns the quaternion added with q (this + q) */ 136 136 inline Quaternion operator+ (const Quaternion& q) const { return Quaternion(q.v + v, q.w + w); }; 137 /** \param q the Quaternion to add to this \returns the quaternion added with q (this += q) */137 /** @param q the Quaternion to add to this @returns the quaternion added with q (this += q) */ 138 138 inline const Quaternion& operator+= (const Quaternion& q) { this->v += q.v; this->w += q.w; return *this; }; 139 /** \param q the Quaternion to substrace from this \returns the quaternion substracted by q (this - q) */139 /** @param q the Quaternion to substrace from this @returns the quaternion substracted by q (this - q) */ 140 140 inline Quaternion operator- (const Quaternion& q) const { return Quaternion(q.v - v, q.w - w); } 141 /** \param q the Quaternion to substrace from this \returns the quaternion substracted by q (this -= q) */141 /** @param q the Quaternion to substrace from this @returns the quaternion substracted by q (this -= q) */ 142 142 inline const Quaternion& operator-= (const Quaternion& q) { this->v -= q.v; this->w -= q.w; return *this; }; 143 /** \brief copy constructor \param q: the Quaternion to set this to. \returns the Quaternion q (or this) */143 /** \brief copy constructor @param q: the Quaternion to set this to. @returns the Quaternion q (or this) */ 144 144 inline Quaternion operator= (const Quaternion& q) {this->v = q.v; this->w = q.w; return *this;} 145 /** \brief conjugates this Quaternion \returns the conjugate */145 /** \brief conjugates this Quaternion @returns the conjugate */ 146 146 inline Quaternion conjugate () const { Quaternion r(*this); r.v = Vector() - r.v; return r;} 147 147 Quaternion inverse () const; -
orxonox/trunk/src/lib/particles/particle_emitter.cc
r4746 r4836 31 31 32 32 /** 33 \briefstandard constructor33 * standard constructor 34 34 */ 35 35 ParticleEmitter::ParticleEmitter(const Vector& direction, float angle, float emissionRate, … … 47 47 48 48 /** 49 \briefconstructs and loads a ParticleEmitter from a XML-element50 \param root the XML-element to load from49 * constructs and loads a ParticleEmitter from a XML-element 50 * @param root the XML-element to load from 51 51 */ 52 52 ParticleEmitter::ParticleEmitter(const TiXmlElement* root) … … 61 61 62 62 /** 63 \briefstandard destructor63 * standard destructor 64 64 65 65 removes the EmitterSystem from the ParticleEngine … … 87 87 88 88 /** 89 \briefloads a ParticleEmitter from a XML-element90 \param root the XML-element to load from89 * loads a ParticleEmitter from a XML-element 90 * @param root the XML-element to load from 91 91 */ 92 92 void ParticleEmitter::loadParams(const TiXmlElement* root) … … 120 120 121 121 /** 122 \briefthis start the emitter122 * this start the emitter 123 123 */ 124 124 void ParticleEmitter::start() {} … … 126 126 127 127 /** 128 \briefthis stops the emitter128 * this stops the emitter 129 129 */ 130 130 void ParticleEmitter::stop() {} … … 135 135 136 136 /** 137 \param type the new Type of this emitter137 * @param type the new Type of this emitter 138 138 */ 139 139 void ParticleEmitter::setType(EMITTER_TYPE type) … … 143 143 144 144 /** 145 \briefsets the type of emitter146 \param type the type as a const char*145 * sets the type of emitter 146 * @param type the type as a const char* 147 147 dot: EMITTER_DOT, plane: EMITTER_PLANE, cube: EMITTER_CUBE, sphere, EMITTER_SPHERE; 148 148 */ … … 172 172 173 173 /** 174 \briefsets a new size to the emitter174 * sets a new size to the emitter 175 175 */ 176 176 void ParticleEmitter::setSize(float emitterSize) … … 183 183 184 184 /** 185 \briefset the emission rate186 \param emissionRate: sets the number of particles emitted per second185 * set the emission rate 186 * @param emissionRate: sets the number of particles emitted per second 187 187 188 188 if you want to change the value of this variable during emission time (to make it more dynamic) … … 198 198 199 199 /** 200 \briefhow much of the speed from the ParticleEmitter should flow onto the ParticleSystem201 \param value a Value between zero and one200 * how much of the speed from the ParticleEmitter should flow onto the ParticleSystem 201 * @param value a Value between zero and one 202 202 203 203 if you want to change the value of this variable during emission time (to make it more dynamic) … … 215 215 216 216 /** 217 \briefset the angle of the emitter218 \param angle around the direction in which there are particles to be emitted219 \param randomAngle A random spread-angle, the +- randomness of this option217 * set the angle of the emitter 218 * @param angle around the direction in which there are particles to be emitted 219 * @param randomAngle A random spread-angle, the +- randomness of this option 220 220 221 221 if you want to change the value of this variable during emission time (to make it more dynamic) … … 229 229 230 230 /** 231 \briefsets the initial velocity of all particles emitted232 \param velocity The starting velocity of the emitted particles233 \param randomVelocity A random starting velocity, the +- randomness of this option231 * sets the initial velocity of all particles emitted 232 * @param velocity The starting velocity of the emitted particles 233 * @param randomVelocity A random starting velocity, the +- randomness of this option 234 234 235 235 if you want to change the value of this variable during emission time (to make it more dynamic) … … 243 243 244 244 /** 245 \briefsets the initial Momentum of all particles emitted246 \param momentum the new Momentum (just a float for being not too complicated).247 \param randomMomentum variation from the given value.245 * sets the initial Momentum of all particles emitted 246 * @param momentum the new Momentum (just a float for being not too complicated). 247 * @param randomMomentum variation from the given value. 248 248 */ 249 249 void ParticleEmitter::setEmissionMomentum(float momentum, float randomMomentum) … … 254 254 255 255 /** 256 \briefthis set the time to life of a particle, after which it will die257 \param dt: the time to live in seconds258 \param system: the system into which to emitt256 * this set the time to life of a particle, after which it will die 257 * @param dt: the time to live in seconds 258 * @param system: the system into which to emitt 259 259 260 260 if you want to change the value of this variable during emission time (to make it more dynamic) … … 308 308 309 309 /** 310 \briefoutputs some nice debug information310 * outputs some nice debug information 311 311 */ 312 312 void ParticleEmitter::debug() const -
orxonox/trunk/src/lib/particles/particle_emitter.h
r4746 r4836 1 1 /*! 2 2 \file particle_emitter.h 3 \briefDefinition of a ParticleEmitter3 * Definition of a ParticleEmitter 4 4 */ 5 5 … … 58 58 void setDirection(float x, float y, float z) { this->direction = Vector(x,y,z); }; //!< todo this should be done via PNODE 59 59 60 /** \returns the type of the emitter */60 /** @returns the type of the emitter */ 61 61 inline EMITTER_TYPE getType() const { return this->type; }; 62 /** \returns the Type as a const char * */62 /** @returns the Type as a const char * */ 63 63 const char* getTypeC() const; 64 /** \returns the Size of the emitter */64 /** @returns the Size of the emitter */ 65 65 inline float getSize() const { return this->emitterSize; }; 66 /** \returns the emissionRate */66 /** @returns the emissionRate */ 67 67 inline float getEmissionRate() const { return this->emissionRate; }; 68 /** \returns the inherit-speed-factor */68 /** @returns the inherit-speed-factor */ 69 69 inline float getInheritSpeed() const { return this->inheritSpeed; }; 70 /** \returns the SpreadAngle of the emitter */70 /** @returns the SpreadAngle of the emitter */ 71 71 inline float getSpread() const { return this->angle; }; 72 /** \returns the EmissionVelocity of the emitter */72 /** @returns the EmissionVelocity of the emitter */ 73 73 inline float getEmissionVelocity() const { return this->velocity; }; 74 /** \returns the EmissionMomentum of this emitter */74 /** @returns the EmissionMomentum of this emitter */ 75 75 inline float getEmissionMomentum() const { return this->momentum; }; 76 76 -
orxonox/trunk/src/lib/particles/particle_engine.cc
r4834 r4836 29 29 30 30 /** 31 \briefstandard constructor31 * standard constructor 32 32 */ 33 33 ParticleEngine::ParticleEngine () … … 42 42 43 43 /** 44 \briefthe singleton reference to this class44 * the singleton reference to this class 45 45 */ 46 46 ParticleEngine* ParticleEngine::singletonRef = NULL; 47 47 48 48 /** 49 \briefdeletes all the system, emitters, connections and Lists49 * deletes all the system, emitters, connections and Lists 50 50 */ 51 51 ParticleEngine::~ParticleEngine () … … 84 84 /** 85 85 \brief loads the ParticleEngines settings and connections between particles and emitters 86 \param root the XML-element to load this from.86 * @param root the XML-element to load this from. 87 87 */ 88 88 void ParticleEngine::loadParams(const TiXmlElement* root) … … 98 98 99 99 /** 100 \briefAdds a System to the System list.100 * Adds a System to the System list. 101 101 102 102 this is done automatically when creating a ParticleSystem … … 108 108 109 109 /** 110 \briefAdds an emitter to the emitterList110 * Adds an emitter to the emitterList 111 111 112 112 this is done automatically when creating a ParticleEmitter … … 119 119 /** 120 120 \brief Connects a ParticleSystem to a ParticleSystem thus emitting Particles. 121 \param emitter the Emitter to connect to the System122 \param system the System to connect to the Emitter121 * @param emitter the Emitter to connect to the System 122 * @param system the System to connect to the Emitter 123 123 */ 124 124 void ParticleEngine::addConnection(const char* emitter, const char* system) … … 139 139 140 140 /** 141 \briefConnects a ParticleSystem to a ParticleSystem thus emitting Particles.142 \param emitter the Emitter to connect to the System143 \param system the System to connect to the Emitter141 * Connects a ParticleSystem to a ParticleSystem thus emitting Particles. 142 * @param emitter the Emitter to connect to the System 143 * @param system the System to connect to the Emitter 144 144 */ 145 145 void ParticleEngine::addConnection(ParticleEmitter* emitter, ParticleSystem* system) … … 171 171 172 172 /** 173 \briefRemoves a system from the systemList and also removes all Connections to the System174 \param system The ParticleSystem to delete173 * Removes a system from the systemList and also removes all Connections to the System 174 * @param system The ParticleSystem to delete 175 175 */ 176 176 bool ParticleEngine::removeSystem(ParticleSystem* system) … … 192 192 193 193 /** 194 \briefremoves an emitter from the emitterList and also from all Connections it is attached to.195 \param emitter the ParticleEmitter to remove.194 * removes an emitter from the emitterList and also from all Connections it is attached to. 195 * @param emitter the ParticleEmitter to remove. 196 196 */ 197 197 bool ParticleEngine::removeEmitter(ParticleEmitter* emitter) … … 213 213 214 214 /** 215 \briefremoves a Connection between an Emitter and a System216 \param emitter The emitter of the connection to remove217 \param system The system of the connection to remove218 \returns true, if the connection was broken, false if the conntection was not found215 * removes a Connection between an Emitter and a System 216 * @param emitter The emitter of the connection to remove 217 * @param system The system of the connection to remove 218 * @returns true, if the connection was broken, false if the conntection was not found 219 219 220 220 only if both system and emitter are in the connection the Connection will be broken … … 240 240 241 241 /** 242 \briefremoves a Connection between an Emitter and a System243 \param connection the connection to remove242 * removes a Connection between an Emitter and a System 243 * @param connection the connection to remove 244 244 245 245 \see bool ParticleEngine::breakConnection(ParticleEmitter* emitter, ParticleSystem* system) … … 253 253 254 254 /** 255 \briefthis function ticks all the ParticleSystems, so an animation will flow256 \param dt passed since last tick255 * this function ticks all the ParticleSystems, so an animation will flow 256 * @param dt passed since last tick 257 257 */ 258 258 void ParticleEngine::tick(float dt) … … 280 280 281 281 /** 282 \briefdraws all the systems and their Particles.282 * draws all the systems and their Particles. 283 283 */ 284 284 void ParticleEngine::draw() const … … 296 296 297 297 /** 298 \param systemName the name of the system to search for299 \returns the system called by systemName or NULL if not found298 * @param systemName the name of the system to search for 299 * @returns the system called by systemName or NULL if not found 300 300 */ 301 301 ParticleSystem* ParticleEngine::getSystemByName(const char* systemName) const … … 317 317 318 318 /** 319 \param number the n-th system to return320 \returns the system called by number or NULL if not found319 * @param number the n-th system to return 320 * @returns the system called by number or NULL if not found 321 321 */ 322 322 ParticleSystem* ParticleEngine::getSystemByNumber(unsigned int number) const … … 340 340 341 341 /** 342 \param emitterName the name of the emitter to search for343 \returns the emitter called by emitterName or NULL if not found342 * @param emitterName the name of the emitter to search for 343 * @returns the emitter called by emitterName or NULL if not found 344 344 */ 345 345 ParticleEmitter* ParticleEngine::getEmitterByName(const char* emitterName) const … … 362 362 363 363 /** 364 \param number the n-th emitter to return365 \returns the emitter called by number or NULL if not found364 * @param number the n-th emitter to return 365 * @returns the emitter called by number or NULL if not found 366 366 */ 367 367 ParticleEmitter* ParticleEngine::getEmitterByNumber(unsigned int number) const … … 385 385 386 386 /** 387 \briefoutputs some nice debug information387 * outputs some nice debug information 388 388 */ 389 389 void ParticleEngine::debug() -
orxonox/trunk/src/lib/particles/particle_engine.h
r4746 r4836 1 1 /*! 2 2 \file particle_engine.h 3 \briefDefinition of the ParticleEngine3 * Definition of the ParticleEngine 4 4 */ 5 5 … … 34 34 public: 35 35 virtual ~ParticleEngine(); 36 /** \returns a Pointer to the only object of this Class */36 /** @returns a Pointer to the only object of this Class */ 37 37 inline static ParticleEngine* getInstance() { if (!singletonRef) singletonRef = new ParticleEngine(); return singletonRef; }; 38 38 -
orxonox/trunk/src/lib/particles/particle_system.cc
r4827 r4836 35 35 36 36 /** 37 \briefstandard constructor38 \param maxCount the Count of particles in the System39 \param type The Type of the ParticleSystem37 * standard constructor 38 * @param maxCount the Count of particles in the System 39 * @param type The Type of the ParticleSystem 40 40 */ 41 41 ParticleSystem::ParticleSystem (unsigned int maxCount, PARTICLE_TYPE type) … … 49 49 /** 50 50 \brief creates a Particle System out of a XML-element 51 \param root: the XML-element to load from51 * @param root: the XML-element to load from 52 52 */ 53 53 ParticleSystem::ParticleSystem(const TiXmlElement* root) … … 59 59 60 60 /** 61 \briefstandard deconstructor61 * standard deconstructor 62 62 */ 63 63 ParticleSystem::~ParticleSystem() … … 147 147 148 148 /** 149 \param maxCount the maximum count of particles that can be emitted149 * @param maxCount the maximum count of particles that can be emitted 150 150 */ 151 151 void ParticleSystem::setMaxCount(int maxCount) … … 156 156 157 157 /** 158 \param particleType the type of particles in this System159 \param count how many particles (in PARTICLE_MULTI-mode)160 \todo this will be different158 * @param particleType the type of particles in this System 159 * @param count how many particles (in PARTICLE_MULTI-mode) 160 @todo this will be different 161 161 */ 162 162 void ParticleSystem::setType(const char* particleType) … … 173 173 174 174 /** 175 \param particleType the type of particles in this System176 \param count how many particles (in PARTICLE_MULTI-mode)177 \todo this will be different175 * @param particleType the type of particles in this System 176 * @param count how many particles (in PARTICLE_MULTI-mode) 177 @todo this will be different 178 178 */ 179 179 void ParticleSystem::setType(PARTICLE_TYPE particleType, int count) … … 205 205 // setting properties 206 206 /** 207 \briefsets the material to an external material208 \param material: the material to set this material to.207 * sets the material to an external material 208 * @param material: the material to set this material to. 209 209 210 210 !! important if the extern material gets deleted it MUST be unregistered here or segfault !! … … 216 216 217 217 /** 218 \briefSets the lifespan of newly created particles218 * Sets the lifespan of newly created particles 219 219 */ 220 220 void ParticleSystem::setLifeSpan(float lifeSpan, float randomLifeSpan) … … 225 225 226 226 /** 227 \briefsets the conserve Factor of newly created particles227 * sets the conserve Factor of newly created particles 228 228 */ 229 229 void ParticleSystem::setConserve(float conserve) … … 241 241 ///////////////////////////// 242 242 /** 243 \briefsets a key in the radius-animation on a per-particle basis244 \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]245 \param radius the radius at this position246 \param randRadius the randRadius at this position243 * sets a key in the radius-animation on a per-particle basis 244 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1] 245 * @param radius the radius at this position 246 * @param randRadius the randRadius at this position 247 247 */ 248 248 void ParticleSystem::setRadius(float lifeCycleTime, float radius, float randRadius) … … 253 253 254 254 /** 255 \briefsets a key in the mass-animation on a per-particle basis256 \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]257 \param mass the mass at this position258 \param randMass the randomMass at this position255 * sets a key in the mass-animation on a per-particle basis 256 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1] 257 * @param mass the mass at this position 258 * @param randMass the randomMass at this position 259 259 */ 260 260 void ParticleSystem::setMass(float lifeCycleTime, float mass, float randMass) … … 265 265 266 266 /** 267 \briefsets a key in the color-animation on a per-particle basis268 \param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]269 \param red: red270 \param green: green271 \param blue: blue272 \param alpha: alpha267 * sets a key in the color-animation on a per-particle basis 268 * @param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1] 269 * @param red: red 270 * @param green: green 271 * @param blue: blue 272 * @param alpha: alpha 273 273 */ 274 274 void ParticleSystem::setColor(float lifeCycleTime, float red, float green, float blue, float alpha) … … 281 281 282 282 /** 283 \briefticks the system.284 \param dt the time to tick all the Particles of the System283 * ticks the system. 284 * @param dt the time to tick all the Particles of the System 285 285 286 286 this is used to get all the particles some motion … … 350 350 351 351 /** 352 \briefapplies some force to a Particle.353 \param field the Field to apply.352 * applies some force to a Particle. 353 * @param field the Field to apply. 354 354 */ 355 355 void ParticleSystem::applyField(Field* field) … … 365 365 366 366 /** 367 * \returns the count of Faces of this ParticleSystem367 * @returns the count of Faces of this ParticleSystem 368 368 */ 369 369 unsigned int ParticleSystem::getFaceCount() const … … 383 383 384 384 /** 385 \briefdraws all the Particles of this System385 * draws all the Particles of this System 386 386 387 387 The Cases in this Function all do the same: … … 410 410 { 411 411 glColor4fv(drawPart->color); 412 //! \todo implement a faster code for the look-at Camera algorithm.413 414 const PNode* camera = State::getCamera(); //!< \todo MUST be different412 //! @todo implement a faster code for the look-at Camera algorithm. 413 414 const PNode* camera = State::getCamera(); //!< @todo MUST be different 415 415 Vector cameraPos = camera->getAbsCoor(); 416 416 Vector cameraTargetPos = State::getCameraTarget()->getAbsCoor(); … … 515 515 516 516 /** 517 \briefadds a new Particle to the System518 \param position the initial position, where the particle gets emitted.519 \param velocity the initial velocity of the particle.520 \param orientation the initial orientation of the Paritcle.521 \param momentum the initial momentum of the Particle (the speed of its rotation).522 \param data some more data given by the emitter517 * adds a new Particle to the System 518 * @param position the initial position, where the particle gets emitted. 519 * @param velocity the initial velocity of the particle. 520 * @param orientation the initial orientation of the Paritcle. 521 * @param momentum the initial momentum of the Particle (the speed of its rotation). 522 * @param data some more data given by the emitter 523 523 */ 524 524 void ParticleSystem::addParticle(const Vector& position, const Vector& velocity, const Quaternion& orientation, const Quaternion& momentum, unsigned int data) … … 566 566 particles->momentum = momentum; 567 567 568 // particle->rotation = ; //! \todo rotation is once again something to be done.568 // particle->rotation = ; //! @todo rotation is once again something to be done. 569 569 particles->massRand = 2*(float)rand()/RAND_MAX -1; 570 570 particles->radiusRand = 2* (float)rand()/RAND_MAX -1; … … 579 579 580 580 /** 581 \briefoutputs some nice debug information581 * outputs some nice debug information 582 582 */ 583 583 void ParticleSystem::debug() const -
orxonox/trunk/src/lib/particles/particle_system.h
r4746 r4836 89 89 void setColor(float lifeCycleTime, float red, float green, float blue, float alpha); 90 90 91 /** \returns the Type of the particles */91 /** @returns the Type of the particles */ 92 92 inline PARTICLE_TYPE getType() const { return this->particleType; }; 93 /** \returns the Material that lies on this particles */93 /** @returns the Material that lies on this particles */ 94 94 inline const Material* getMaterial() const { return this->material; }; 95 /** \returns the lifespan of the particles */95 /** @returns the lifespan of the particles */ 96 96 inline float getLifeSpan() const { return this->lifeSpan; }; 97 /** \returns the starting-radius of the particles */97 /** @returns the starting-radius of the particles */ 98 98 inline float getStartRadius() { return this->radiusAnim.getValue(0.0); }; 99 /** \returns the end-radius of the particles */99 /** @returns the end-radius of the particles */ 100 100 inline float getEndRadius() { return this->radiusAnim.getValue(1.0); }; 101 /** \returns the conserve-factor of the particles */101 /** @returns the conserve-factor of the particles */ 102 102 inline float getConserve() const { return this->conserve; }; 103 /** \returns the initial mass of the particles */103 /** @returns the initial mass of the particles */ 104 104 inline float getMass() const { return this->initialMass; }; 105 105 … … 108 108 109 109 virtual void applyField(Field* field); 110 /** \brief this is an empty function, because the Physics are implemented in tick \param dt: useless here */110 /** \brief this is an empty function, because the Physics are implemented in tick @param dt: useless here */ 111 111 virtual void tickPhys(float dt) {}; 112 112 -
orxonox/trunk/src/lib/particles/quick_animation.cc
r4746 r4836 28 28 29 29 /** 30 \briefstandard constructor30 * standard constructor 31 31 */ 32 32 QuickAnimation::QuickAnimation () … … 43 43 44 44 /** 45 \briefdeletes all the deconstructor stuff45 * deletes all the deconstructor stuff 46 46 */ 47 47 QuickAnimation::~QuickAnimation () … … 60 60 61 61 /** 62 \briefadds a new entry to the list of keyframes63 \param position the position to add the key to64 \param value the Value to set for the position65 \returns false if the key existed already for a given position62 * adds a new entry to the list of keyframes 63 * @param position the position to add the key to 64 * @param value the Value to set for the position 65 * @returns false if the key existed already for a given position 66 66 */ 67 67 void QuickAnimation::addEntry(float position, float value) … … 128 128 129 129 /** 130 \briefchanges an entry in the region of position131 \param position the Position of an existing keyframe132 \param region a deviation of the existing keyframe (like a delta in witch to search for133 \param value the new Value130 * changes an entry in the region of position 131 * @param position the Position of an existing keyframe 132 * @param region a deviation of the existing keyframe (like a delta in witch to search for 133 * @param value the new Value 134 134 135 135 if the Entry at the in the region of the specified position is found, it will be changed. 136 136 Otherwise a new KeyFrame will be created with value at position. 137 \todo rimplement137 @todo rimplement 138 138 */ 139 139 void QuickAnimation::changeEntry(float position, float value, float region) … … 202 202 203 203 /** 204 \briefreturns the value of the animation at a certain position205 \param position the position to get the value from :)204 * returns the value of the animation at a certain position 205 * @param position the position to get the value from :) 206 206 */ 207 207 float QuickAnimation::getValue(float position) … … 226 226 227 227 /** 228 \briefoutputs some nice information about this class228 * outputs some nice information about this class 229 229 */ 230 230 void QuickAnimation::debug() -
orxonox/trunk/src/lib/particles/quick_animation.h
r4746 r4836 1 1 /*! 2 2 \file quick_animation.h 3 \briefDefinition of the QuickAnimation-class3 * Definition of the QuickAnimation-class 4 4 5 5 */ … … 43 43 44 44 void removeEntry(float position); 45 /** \todo implemente those functions45 /** @todo implemente those functions 46 46 bool moveEntry(float position); 47 47 */ -
orxonox/trunk/src/lib/physics/fields/field.cc
r4746 r4836 25 25 26 26 /** 27 \briefstandard constructor27 * standard constructor 28 28 */ 29 29 Field::Field () … … 33 33 34 34 /** 35 \briefstandard deconstructor35 * standard deconstructor 36 36 37 37 */ … … 54 54 55 55 /** 56 \param root The XML-element to load settings from56 * @param root The XML-element to load settings from 57 57 */ 58 58 void Field::loadParams(const TiXmlElement* root) … … 69 69 70 70 /** 71 \param magnitude the magnitude of the Field.71 * @param magnitude the magnitude of the Field. 72 72 */ 73 73 void Field::setMagnitude(float magnitude) … … 77 77 78 78 /** 79 \param attenuation The attenuation of the Field (the bigger the smaller the region of influence)79 * @param attenuation The attenuation of the Field (the bigger the smaller the region of influence) 80 80 */ 81 81 void Field::setAttenuation(float attenuation) -
orxonox/trunk/src/lib/physics/fields/field.h
r4746 r4836 16 16 /*! 17 17 \file field.h 18 \briefabstract definition of a Physical Field18 * abstract definition of a Physical Field 19 19 20 20 This is a totally abstract class, that only enables different Physical Fields to … … 42 42 43 43 /** 44 \param data This is the data given to this force, to calculate the ForceVector45 \returns The Force Vector44 * @param data This is the data given to this force, to calculate the ForceVector 45 * @returns The Force Vector 46 46 */ 47 47 virtual Vector calcForce(const Vector& data) const = 0; 48 48 49 49 void setMagnitude(float magnitude); 50 /** \returns The Magnitude of the Field */50 /** @returns The Magnitude of the Field */ 51 51 inline const float& getMagnitude() const {return this->magnitude;} 52 52 53 53 void setAttenuation(float attenuation); 54 /** \returns The Attenuation of the Fiels */54 /** @returns The Attenuation of the Fiels */ 55 55 inline const float& getAttenuation() const {return this->attenuation;} 56 56 -
orxonox/trunk/src/lib/physics/fields/fields.h
r4338 r4836 16 16 /*! 17 17 \file fields.h 18 \briefcollection of all Headers of all the different fileds there are in the18 * collection of all Headers of all the different fileds there are in the 19 19 PhysicsEngine 20 20 */ -
orxonox/trunk/src/lib/physics/fields/gravity.cc
r4742 r4836 34 34 35 35 /** 36 \briefstandard deconstructor36 * standard deconstructor 37 37 38 38 */ … … 48 48 49 49 /** 50 \briefcalculates the Gravity on any point in space51 \param data The Position of the Point in space to attache gravity to.52 \returns The force.50 * calculates the Gravity on any point in space 51 * @param data The Position of the Point in space to attache gravity to. 52 * @returns The force. 53 53 */ 54 54 Vector Gravity::calcForce(const Vector& data) const -
orxonox/trunk/src/lib/physics/fields/gravity.h
r4742 r4836 1 1 /*! 2 2 \file gravity.h 3 \briefDefinition of ...3 * Definition of ... 4 4 5 5 */ -
orxonox/trunk/src/lib/physics/fields/point_gravity.cc
r4742 r4836 22 22 23 23 /** 24 \briefstandard constructor25 \todo this constructor is not jet implemented - do it24 * standard constructor 25 @todo this constructor is not jet implemented - do it 26 26 */ 27 27 PointGravity::PointGravity () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ … … 41 41 42 42 /** 43 \briefcalculates the PointGravity on any point in space44 \param data The Position of the Point in space to attache PointGravity to.45 \returns The force.43 * calculates the PointGravity on any point in space 44 * @param data The Position of the Point in space to attache PointGravity to. 45 * @returns The force. 46 46 */ 47 47 Vector PointGravity::calcForce(const Vector& data) const -
orxonox/trunk/src/lib/physics/fields/point_gravity.h
r4395 r4836 1 1 /*! 2 2 \file point_gravity.h 3 \briefDefinition of ...3 * Definition of ... 4 4 5 5 */ -
orxonox/trunk/src/lib/physics/fields/twirl.cc
r4742 r4836 22 22 23 23 /** 24 \briefstandard constructor25 \todo this constructor is not jet implemented - do it24 * standard constructor 25 @todo this constructor is not jet implemented - do it 26 26 */ 27 27 Twirl::Twirl () … … 32 32 33 33 /** 34 \briefstandard deconstructor34 * standard deconstructor 35 35 36 36 */ … … 41 41 42 42 /** 43 \briefcalculates the Twirl on any point in space44 \param data The Position of the Point in space to attache twirl to.45 \returns The force.43 * calculates the Twirl on any point in space 44 * @param data The Position of the Point in space to attache twirl to. 45 * @returns The force. 46 46 */ 47 47 Vector Twirl::calcForce(const Vector& data) const -
orxonox/trunk/src/lib/physics/fields/twirl.h
r4395 r4836 1 1 /*! 2 2 \file twirl.h 3 \briefDefinition of ...3 * Definition of ... 4 4 5 5 */ -
orxonox/trunk/src/lib/physics/physics_connection.cc
r4746 r4836 31 31 32 32 /** 33 \briefcreates a PhysicsConnection33 * creates a PhysicsConnection 34 34 */ 35 35 PhysicsConnection::PhysicsConnection(PhysicsInterface* subject, Field* field) … … 61 61 62 62 /** 63 \briefstandard deconstructor63 * standard deconstructor 64 64 65 65 */ … … 70 70 71 71 /** 72 \param subjectName the name of the Subject for this PhysicsConnection72 * @param subjectName the name of the Subject for this PhysicsConnection 73 73 */ 74 74 void PhysicsConnection::setSubject(const char* subjectName) … … 84 84 85 85 /** 86 \param fieldName the Name of the Field for this connection86 * @param fieldName the Name of the Field for this connection 87 87 */ 88 88 void PhysicsConnection::setField(const char* fieldName) … … 99 99 100 100 /** 101 \briefapplies the Force to some Object.101 * applies the Force to some Object. 102 102 */ 103 103 void PhysicsConnection::apply() const -
orxonox/trunk/src/lib/physics/physics_connection.h
r4746 r4836 1 1 /*! 2 2 \file physics_connection.h 3 \briefDefinition of The Physical Connection Class.3 * Definition of The Physical Connection Class. 4 4 */ 5 5 -
orxonox/trunk/src/lib/physics/physics_engine.cc
r4749 r4836 29 29 30 30 /** 31 \briefstandard constructor31 * standard constructor 32 32 */ 33 33 PhysicsEngine::PhysicsEngine() … … 41 41 42 42 /** 43 \briefthe singleton reference to this class43 * the singleton reference to this class 44 44 */ 45 45 PhysicsEngine* PhysicsEngine::singletonRef = NULL; 46 46 47 47 /** 48 \briefstandard deconstructor48 * standard deconstructor 49 49 50 50 */ … … 91 91 92 92 /** 93 \param root the XML-element to load settings from93 * @param root the XML-element to load settings from 94 94 */ 95 95 void PhysicsEngine::loadParams(const TiXmlElement* root) … … 103 103 104 104 /** 105 * \param root the XML-element to Load the PhysicsField from105 * @param root the XML-element to Load the PhysicsField from 106 106 */ 107 107 void PhysicsEngine::loadFields(const TiXmlElement* root) … … 119 119 120 120 /** 121 * \param root the XML-element to load the PhysicsConnection from121 * @param root the XML-element to load the PhysicsConnection from 122 122 */ 123 123 void PhysicsEngine::loadConnections(const TiXmlElement* root) … … 135 135 136 136 /** 137 \briefadds a PhysicsInterface to the list of handeled physicsInterfaces138 \param physicsInterface the interface to add137 * adds a PhysicsInterface to the list of handeled physicsInterfaces 138 * @param physicsInterface the interface to add 139 139 140 140 this is normally done in the constructor of any PhysicsInterface … … 146 146 147 147 /** 148 \briefremoves a PhysicsInterface from the list of handeled physicsInterfaces149 \param physicsInterface the interface to remove148 * removes a PhysicsInterface from the list of handeled physicsInterfaces 149 * @param physicsInterface the interface to remove 150 150 151 151 this is normally done in the destructor of any PhysicsInterface … … 157 157 158 158 /** 159 \param physicsInterfaceName the Name of the PhysicsInterface to search for160 \returns the PhysicsInterface if found, or NULL if not159 * @param physicsInterfaceName the Name of the PhysicsInterface to search for 160 @returns the PhysicsInterface if found, or NULL if not 161 161 */ 162 162 PhysicsInterface* PhysicsEngine::getPhysicsInterfaceByName(const char* physicsInterfaceName) const … … 178 178 179 179 /** 180 \briefadds a Field to the list of handeled fields181 \param field the field to add180 * adds a Field to the list of handeled fields 181 * @param field the field to add 182 182 183 183 this is normally done in the constructor of any Field … … 189 189 190 190 /** 191 \briefremoves a Field from the list of handeled fields192 \param field the field to remove191 * removes a Field from the list of handeled fields 192 * @param field the field to remove 193 193 194 194 this is normally done in the destructor of any Field … … 200 200 201 201 /** 202 \param FieldName the Name of the PhysicsInterface to search for203 \returns the Field if found, or NULL if not202 * @param FieldName the Name of the PhysicsInterface to search for 203 @returns the Field if found, or NULL if not 204 204 */ 205 205 Field* PhysicsEngine::getFieldByName(const char* FieldName) const … … 223 223 224 224 /** 225 \briefadds A Physical Connection to the List of Connections226 \param connection the Connection to add225 * adds A Physical Connection to the List of Connections 226 * @param connection the Connection to add 227 227 228 228 Usually this is done through the constructor of PhysicshConnections … … 234 234 235 235 /** 236 \briefremoves A Physical Connection from the List of Connections237 \param connection the Connection to remove236 * removes A Physical Connection from the List of Connections 237 * @param connection the Connection to remove 238 238 239 239 Usually this is done through the destructor of PhysicsConnections … … 245 245 246 246 /** 247 \param physicsConnectionName the Name of the PhysicsInterface to search for248 \returns the PhysicsConnection if found, or NULL if not247 * @param physicsConnectionName the Name of the PhysicsInterface to search for 248 @returns the PhysicsConnection if found, or NULL if not 249 249 */ 250 250 PhysicsConnection* PhysicsEngine::getPhysicsConnectionByName(const char* physicsConnectionName) const … … 268 268 269 269 /** 270 \briefSteps through all the Connections and Ticks them271 \param dt The time Passed in Seconds270 * Steps through all the Connections and Ticks them 271 * @param dt The time Passed in Seconds 272 272 273 273 This function brings a flow into the whole animation … … 302 302 303 303 /** 304 \briefprint out interesting debug information of this class304 * print out interesting debug information of this class 305 305 */ 306 306 void PhysicsEngine::debug() const -
orxonox/trunk/src/lib/physics/physics_engine.h
r4746 r4836 1 1 /*! 2 2 \file physics_engine.h 3 \briefDefinition of the PhysicsEngine-singleton Class3 * Definition of the PhysicsEngine-singleton Class 4 4 5 5 */ … … 23 23 public: 24 24 virtual ~PhysicsEngine(); 25 /** \returns a Pointer to the only object of this Class */25 /** @returns a Pointer to the only object of this Class */ 26 26 inline static PhysicsEngine* getInstance() { if (!singletonRef) singletonRef = new PhysicsEngine(); return singletonRef; }; 27 27 -
orxonox/trunk/src/lib/physics/physics_interface.cc
r4762 r4836 34 34 35 35 /** 36 \briefstandard constructor36 * standard constructor 37 37 */ 38 38 PhysicsInterface::PhysicsInterface () … … 49 49 50 50 /** 51 \briefstandard deconstructor51 * standard deconstructor 52 52 */ 53 53 PhysicsInterface::~PhysicsInterface () … … 57 57 58 58 /** 59 \briefrecalculates the total mass of all the children of this node59 * recalculates the total mass of all the children of this node 60 60 61 61 (only availiable for PNodes) … … 64 64 { 65 65 /* 66 PNode* massCalcPNode = dynamic_cast<PNode*>(this); //! \todo not sure if this will work ....66 PNode* massCalcPNode = dynamic_cast<PNode*>(this); //! @todo not sure if this will work .... 67 67 float massSum = 0; 68 68 … … 90 90 91 91 /** 92 \briefapplyes a field to this Object93 \param field the field to apply92 * applyes a field to this Object 93 * @param field the field to apply 94 94 */ 95 95 void PhysicsInterface::applyField(Field* field) … … 101 101 102 102 /** 103 \briefticks the PhysicsEffect104 \param dt: the value about which to tick103 * ticks the PhysicsEffect 104 * @param dt: the value about which to tick 105 105 */ 106 106 void PhysicsInterface::tickPhys( float dt ) -
orxonox/trunk/src/lib/physics/physics_interface.h
r4762 r4836 1 1 /*! 2 2 \file physics_interface.h 3 \briefa physics interface simulating a body with a mass3 * a physics interface simulating a body with a mass 4 4 */ 5 5 … … 31 31 PhysicsInterface(); 32 32 virtual ~PhysicsInterface(); 33 /** \param mass the mass to set for this node. */33 /** @param mass the mass to set for this node. */ 34 34 inline void setMass( float mass ) { this->mass = mass; }; 35 /** \returns the mass of the node. */35 /** @returns the mass of the node. */ 36 36 inline float getMass( void ) const { return mass; }; 37 /** \returns the mass of this node plus all its children (only valid for PNodes). */37 /** @returns the mass of this node plus all its children (only valid for PNodes). */ 38 38 inline float getTotalMass( void ) const { return mass + massChildren; }; 39 39 -
orxonox/trunk/src/lib/sound/ogg_player.h
r4750 r4836 1 1 /*! 2 2 * @file ogg_player.h 3 * @briefOgg-Player definition3 * Ogg-Player definition 4 4 */ 5 5 -
orxonox/trunk/src/lib/sound/sound_engine.cc
r4830 r4836 35 35 ////////////////// 36 36 /** 37 \briefCreates a Soundbuffer out of an inputfile38 \param fileName The name of the File37 * Creates a Soundbuffer out of an inputfile 38 * @param fileName The name of the File 39 39 */ 40 40 SoundBuffer::SoundBuffer(const char* fileName) … … 89 89 ////////////////// 90 90 /** 91 \briefcreates a SoundSource at position sourceNode with the SoundBuffer buffer91 * creates a SoundSource at position sourceNode with the SoundBuffer buffer 92 92 */ 93 93 SoundSource::SoundSource(SoundBuffer* buffer, PNode* sourceNode) … … 113 113 114 114 /** 115 \briefdeletes a SoundSource115 * deletes a SoundSource 116 116 */ 117 117 SoundSource::~SoundSource() … … 123 123 124 124 /** 125 \briefPlays back a SoundSource125 * Plays back a SoundSource 126 126 */ 127 127 void SoundSource::play() … … 131 131 132 132 /** 133 \briefStops playback of a SoundSource133 * Stops playback of a SoundSource 134 134 */ 135 135 void SoundSource::stop() … … 139 139 140 140 /** 141 \briefPauses Playback of a SoundSource141 * Pauses Playback of a SoundSource 142 142 */ 143 143 void SoundSource::pause() … … 147 147 148 148 /** 149 \briefRewinds Playback of a SoundSource149 * Rewinds Playback of a SoundSource 150 150 */ 151 151 void SoundSource::rewind() … … 155 155 156 156 /** 157 \briefsets the RolloffFactor of the Sound emitted from the SoundSource158 \param rolloffFactor The Factor described157 * sets the RolloffFactor of the Sound emitted from the SoundSource 158 * @param rolloffFactor The Factor described 159 159 160 160 this tells openAL how fast the Sounds decay outward from the Source … … 171 171 ////////////////// 172 172 /** 173 \briefstandard constructor173 * standard constructor 174 174 */ 175 175 SoundEngine::SoundEngine () … … 184 184 185 185 /** 186 \briefthe singleton reference to this class186 * the singleton reference to this class 187 187 */ 188 188 SoundEngine* SoundEngine::singletonRef = NULL; 189 189 190 190 /** 191 \briefstandard deconstructor191 * standard deconstructor 192 192 193 193 */ … … 221 221 222 222 /** 223 \briefcreates a new SoundSource.224 \param fileName The Name to load the SoundBuffer from225 \param sourceNode The sourceNode to bind this SoundSource to.226 \returns The newly created SoundSource223 * creates a new SoundSource. 224 * @param fileName The Name to load the SoundBuffer from 225 * @param sourceNode The sourceNode to bind this SoundSource to. 226 * @returns The newly created SoundSource 227 227 228 228 acctualy this is nothing more than a wrapper around the ResourceManager. … … 235 235 236 236 /** 237 \briefsets The listener (normaly the Camera)237 * sets The listener (normaly the Camera) 238 238 */ 239 239 void SoundEngine::setListener(PNode* listener) … … 243 243 244 244 /** 245 \briefSets the doppler values of openAL246 \param dopplerFactor the extent of the doppler-effect247 \param dopplerVelocity the Speed the sound travels245 * Sets the doppler values of openAL 246 * @param dopplerFactor the extent of the doppler-effect 247 * @param dopplerVelocity the Speed the sound travels 248 248 */ 249 249 void SoundEngine::setDopplerValues(ALfloat dopplerFactor, ALfloat dopplerVelocity) … … 255 255 256 256 /** 257 \briefadds a SoundBuffer to the bufferList of the SoundEngine258 \param buffer The buffer to add to the bufferList257 * adds a SoundBuffer to the bufferList of the SoundEngine 258 * @param buffer The buffer to add to the bufferList 259 259 */ 260 260 void SoundEngine::addBuffer(SoundBuffer* buffer) … … 264 264 265 265 /** 266 \briefremoves a SoundBuffer from the bufferList of the SoundEngine267 \param buffer The buffer to delete from the SoundEngine266 * removes a SoundBuffer from the bufferList of the SoundEngine 267 * @param buffer The buffer to delete from the SoundEngine 268 268 */ 269 269 void SoundEngine::removeBuffer(SoundBuffer* buffer) … … 285 285 286 286 /** 287 \briefadds a SoundSource to the sourceList of the SoundEngine288 \param source The source to add to the sourceList287 * adds a SoundSource to the sourceList of the SoundEngine 288 * @param source The source to add to the sourceList 289 289 */ 290 290 void SoundEngine::addSource(SoundSource* source) … … 294 294 295 295 /** 296 \briefremoves a SoundSource from the sourceList of the SoundEngine297 \param source The source to delete from the SoundEngine296 * removes a SoundSource from the sourceList of the SoundEngine 297 * @param source The source to delete from the SoundEngine 298 298 */ 299 299 void SoundEngine::removeSource(SoundSource* source) … … 304 304 305 305 /** 306 \briefupdates all The positions, Directions and Velocities of all Sounds306 * updates all The positions, Directions and Velocities of all Sounds 307 307 */ 308 308 void SoundEngine::update() … … 349 349 350 350 /** 351 \briefRemoves all the Buffers that are not anymore needed by any Sources351 * Removes all the Buffers that are not anymore needed by any Sources 352 352 */ 353 353 void SoundEngine::flushUnusedBuffers() … … 374 374 375 375 /** 376 \briefSourceEngine::flushAllBuffers376 * SourceEngine::flushAllBuffers 377 377 */ 378 378 void SoundEngine::flushAllBuffers() … … 389 389 390 390 /** 391 * @briefSourceEngine::flushAllBuffers391 * SourceEngine::flushAllBuffers 392 392 */ 393 393 void SoundEngine::flushAllSources() … … 405 405 406 406 /** 407 \briefinitializes Audio in general407 * initializes Audio in general 408 408 */ 409 409 bool SoundEngine::initAudio() … … 421 421 422 422 /** 423 \briefTransforms AL-errors into something readable424 \param err The error found423 * Transforms AL-errors into something readable 424 * @param err The error found 425 425 */ 426 426 void SoundEngine::PrintALErrorString(ALenum err) -
orxonox/trunk/src/lib/sound/sound_engine.h
r4830 r4836 1 1 /*! 2 2 \file sound_engine.h 3 \briefDefinition of the SoundEngine singleton Class3 * Definition of the SoundEngine singleton Class 4 4 */ 5 5 … … 26 26 ~SoundBuffer(); 27 27 28 /** \returns the ID of the buffer used in this SoundBuffer */28 /** @returns the ID of the buffer used in this SoundBuffer */ 29 29 inline ALuint getID() { return this->bufferID; } 30 30 … … 50 50 51 51 // development functions 52 /** \returns The ID of this Source */52 /** @returns The ID of this Source */ 53 53 inline ALuint getID() const { return this->sourceID; } 54 /** \returns the SoundBuffer of this Source */54 /** @returns the SoundBuffer of this Source */ 55 55 inline SoundBuffer* getBuffer() const { return this->buffer; } 56 /** \returns the SourceNode of this Source */56 /** @returns the SourceNode of this Source */ 57 57 inline PNode* getNode() const { return this->sourceNode;} 58 58 … … 72 72 public: 73 73 virtual ~SoundEngine(); 74 /** \returns a Pointer to the only object of this Class */74 /** @returns a Pointer to the only object of this Class */ 75 75 inline static SoundEngine* getInstance() { if (!singletonRef) singletonRef = new SoundEngine(); return singletonRef; }; 76 76 -
orxonox/trunk/src/lib/util/ini_parser.cc
r4767 r4836 23 23 24 24 /** 25 \briefconstructs an IniParser using a file26 \param filename: the path and name of the file to parse25 * constructs an IniParser using a file 26 * @param filename: the path and name of the file to parse 27 27 */ 28 28 IniParser::IniParser (const char* filename) … … 36 36 37 37 /** 38 \briefremoves the IniParser from memory38 * removes the IniParser from memory 39 39 */ 40 40 IniParser::~IniParser () … … 44 44 45 45 /** 46 \briefopens another file to parse47 \param filename: path and name of the new file to parse48 \return zero on success or -1 if an error occured;46 * opens another file to parse 47 * @param filename: path and name of the new file to parse 48 * @return zero on success or -1 if an error occured; 49 49 */ 50 50 int IniParser::openFile(const char* filename) … … 65 65 66 66 /** 67 \briefset the parsing cursor to the specified section68 \param section: the name of the section to set the cursor to69 \return zero on success or -1 if the section could not be found67 * set the parsing cursor to the specified section 68 * @param section: the name of the section to set the cursor to 69 * @return zero on success or -1 if the section could not be found 70 70 */ 71 71 int IniParser::getSection( const char* section) … … 103 103 104 104 /** 105 \briefgets the next VarName=VarValue pair from the parsing stream106 \param name: a pointer to a buffer to store the name of the entry107 \param value: a pointer to a buffer to store the value of the entry108 \return zero if the buffers have been filled with data or -1 if there are no entries left in the current section105 * gets the next VarName=VarValue pair from the parsing stream 106 * @param name: a pointer to a buffer to store the name of the entry 107 * @param value: a pointer to a buffer to store the value of the entry 108 * @return zero if the buffers have been filled with data or -1 if there are no entries left in the current section 109 109 */ 110 110 int IniParser::nextVar( const char* name, const char* value) … … 148 148 149 149 /** 150 \briefdirectly acesses an entry in a section151 \param name: the name of the entry to find152 \param section: the section where the entry is to be found153 \param defvalue: what should be returned in case the entry cannot be found154 \return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found150 * directly acesses an entry in a section 151 * @param name: the name of the entry to find 152 * @param section: the section where the entry is to be found 153 * @param defvalue: what should be returned in case the entry cannot be found 154 * @return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found 155 155 156 156 The returned pointer points to an internal buffer, so do not free it on your own. Do not give a NULL pointer to defvalue, this will certainly -
orxonox/trunk/src/lib/util/ini_parser.h
r4767 r4836 1 1 /*! 2 2 \file ini_parser.h 3 \briefA small ini file parser3 * A small ini file parser 4 4 5 5 Can be used to find a defined [Section] in an ini file and get the VarName=Value entries -
orxonox/trunk/src/lib/util/list.h
r4694 r4836 23 23 24 24 /** 25 \briefan iterator class25 * an iterator class 26 26 27 27 this enables the user to iterate through a list very easely … … 44 44 45 45 /** 46 \briefiterator constructor47 \param startElement: the first list element from the tList46 * iterator constructor 47 * @param startElement: the first list element from the tList 48 48 49 49 normaly you will use it like this: … … 68 68 69 69 /** 70 \briefthe destructor70 * the destructor 71 71 */ 72 72 template<class T> … … 78 78 79 79 /** 80 \briefuse it to iterate through the list81 \returns next list element80 * use it to iterate through the list 81 * @returns next list element 82 82 */ 83 83 template<class T> … … 93 93 94 94 /** 95 \briefgets the element after the selected one, sets the iterator to this point in the list96 \param element the element to seek97 \returns next list element95 * gets the element after the selected one, sets the iterator to this point in the list 96 * @param element the element to seek 97 * @returns next list element 98 98 99 99 Attention: if you seek an element, the iterator pointer will point to the NEXT listelement after the argument! … … 120 120 121 121 /** 122 \briefthe list template class122 * the list template class 123 123 124 124 you will use this as a generic list for all type of objects … … 151 151 152 152 /** 153 \briefthe constructor153 * the constructor 154 154 */ 155 155 template<class T> … … 163 163 164 164 /** 165 \briefthe deconstructor165 * the deconstructor 166 166 167 167 this will delete only the list. ATTENTION: the list is deleted, but the objects in the list will … … 186 186 187 187 /** 188 \briefadd an entity to the list189 \param entity: the entity to add188 * add an entity to the list 189 * @param entity: the entity to add 190 190 */ 191 191 template<class T> … … 207 207 208 208 /** 209 \briefremove an entity from the list210 \param entity: the entity to be removed209 * remove an entity from the list 210 * @param entity: the entity to be removed 211 211 */ 212 212 template<class T> … … 235 235 236 236 /** 237 \briefthis will deletes the objects from the list237 * this will deletes the objects from the list 238 238 */ 239 239 template<class T> … … 255 255 256 256 /** 257 \briefreturns the first element of the list258 \returns first element257 * returns the first element of the list 258 * @returns first element 259 259 */ 260 260 template<class T> … … 266 266 267 267 /** 268 \brieffunction returns the last element of the list269 \returns the last element268 * function returns the last element of the list 269 * @returns the last element 270 270 */ 271 271 template<class T> … … 277 277 278 278 /** 279 \briefreturns true if the list is empty280 \returns true if the list is empty279 * returns true if the list is empty 280 * @returns true if the list is empty 281 281 */ 282 282 template<class T> … … 287 287 288 288 /** 289 \briefchecks if an entity is in the List290 \param entity The entity to check for in the entire List.291 \returns true if it is, false otherwise289 * checks if an entity is in the List 290 * @param entity The entity to check for in the entire List. 291 * @returns true if it is, false otherwise 292 292 */ 293 293 template<class T> … … 311 311 312 312 /** 313 \briefthis returns the number of elements in the list314 \returns number of elements313 * this returns the number of elements in the list 314 * @returns number of elements 315 315 */ 316 316 template<class T> … … 322 322 323 323 /** 324 \briefcreates an itereator object and returns it325 \returns the iterator object to this list324 * creates an itereator object and returns it 325 * @returns the iterator object to this list 326 326 327 327 You will use this, if you want to iterate through the list … … 337 337 338 338 /** 339 \briefthis returns the next element after toEntity or the first if toEntity is last340 \param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase341 \returns the element after toEntity339 * this returns the next element after toEntity or the first if toEntity is last 340 * @param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase 341 * @returns the element after toEntity 342 342 */ 343 343 template<class T> … … 359 359 360 360 /** 361 \briefcreates an array out of the list (ATTENTION: not implemented)362 \returns pointer to the array beginning361 * creates an array out of the list (ATTENTION: not implemented) 362 * @returns pointer to the array beginning 363 363 364 364 ATTENTION: function is not implemented and wont do anything -
orxonox/trunk/src/lib/util/substring.cc
r4833 r4836 18 18 19 19 /** 20 \briefbreaks a string into parts that were initially seperated by comma21 \param string the string to break into substrings20 * breaks a string into parts that were initially seperated by comma 21 * @param string the string to break into substrings 22 22 */ 23 23 … … 68 68 69 69 /** 70 \briefremoves the object from memory70 * removes the object from memory 71 71 */ 72 72 SubString::~SubString() … … 81 81 82 82 /** 83 \briefget a particular substring84 \param i the ID of the substring to return85 \returns the designated substring or NULL if an invalid ID was given83 * get a particular substring 84 * @param i the ID of the substring to return 85 * @returns the designated substring or NULL if an invalid ID was given 86 86 */ 87 87 const char* SubString::getString( int i)
Note: See TracChangeset
for help on using the changeset viewer.