Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/physics
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (20 years ago)
-
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit
- Location:
- orxonox/trunk/src/lib/physics
- Files:
-
- 15 edited
-
fields/field.cc (modified) (5 diffs)
-
fields/field.h (modified) (2 diffs)
-
fields/fields.h (modified) (1 diff)
-
fields/gravity.cc (modified) (2 diffs)
-
fields/gravity.h (modified) (1 diff)
-
fields/point_gravity.cc (modified) (3 diffs)
-
fields/point_gravity.h (modified) (1 diff)
-
fields/twirl.cc (modified) (3 diffs)
-
fields/twirl.h (modified) (1 diff)
-
physics_connection.cc (modified) (5 diffs)
-
physics_connection.h (modified) (1 diff)
-
physics_engine.cc (modified) (16 diffs)
-
physics_engine.h (modified) (2 diffs)
-
physics_interface.cc (modified) (6 diffs)
-
physics_interface.h (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
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
Note: See TracChangeset
for help on using the changeset viewer.
