mrq/reactphysics3d
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve code documentation inside RigidBody class

Browse Source
This commit is contained in:
Daniel Chappuis 2020-06-16 23:17:41 +02:00
parent cf01689b63
commit bbd9182f7f
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/body/RigidBody.cpp
View File

@ -139,7 +139,7 @@ decimal RigidBody::getMass() const {
/// reset to zero at the end of each call of the PhyscisWorld::update() method. /// reset to zero at the end of each call of the PhyscisWorld::update() method.
/// You can only apply a force to a dynamic body otherwise, this method will do nothing. /// You can only apply a force to a dynamic body otherwise, this method will do nothing.
/** /**
* @param force The force to apply on the body (in Newtons) * @param force The force (in world-space) to apply on the body (in Newtons)
* @param point The point where the force is applied (in local-space coordinates) * @param point The point where the force is applied (in local-space coordinates)
*/ */
void RigidBody::applyForceAtLocalPosition(const Vector3& force, const Vector3& point) { void RigidBody::applyForceAtLocalPosition(const Vector3& force, const Vector3& point) {
@ -171,7 +171,7 @@ void RigidBody::applyForceAtLocalPosition(const Vector3& force, const Vector3& p
/// reset to zero at the end of each call of the PhyscisWorld::update() method. /// reset to zero at the end of each call of the PhyscisWorld::update() method.
/// You can only apply a force to a dynamic body otherwise, this method will do nothing. /// You can only apply a force to a dynamic body otherwise, this method will do nothing.
/** /**
* @param force The force to apply on the body (in Newtons) * @param force The force (in world-space) to apply on the body (in Newtons)
* @param point The point where the force is applied (in world-space coordinates) * @param point The point where the force is applied (in world-space coordinates)
*/ */
void RigidBody::applyForceAtWorldPosition(const Vector3& force, const Vector3& point) { void RigidBody::applyForceAtWorldPosition(const Vector3& force, const Vector3& point) {
@ -228,7 +228,7 @@ void RigidBody::setLocalInertiaTensor(const Vector3& inertiaTensorLocal) {
/// reset to zero at the end of each call of the PhyscisWorld::update() method. /// reset to zero at the end of each call of the PhyscisWorld::update() method.
/// You can only apply a force to a dynamic body otherwise, this method will do nothing. /// You can only apply a force to a dynamic body otherwise, this method will do nothing.
/** /**
* @param force The external force to apply on the center of mass of the body (in Newtons) * @param force The external force (in world-space) to apply on the center of mass of the body (in Newtons)
*/ */
void RigidBody::applyForceToCenterOfMass(const Vector3& force) { void RigidBody::applyForceToCenterOfMass(const Vector3& force) {