Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::Model Class Reference

The actual musculoskeletal model that holds everything in biorbd. More...

#include <BiorbdModel.h>

Inheritance diagram for BIORBD_NAMESPACE::Model:
BIORBD_NAMESPACE::rigidbody::Joints BIORBD_NAMESPACE::rigidbody::Markers BIORBD_NAMESPACE::rigidbody::IMUs BIORBD_NAMESPACE::rigidbody::RotoTransNodes BIORBD_NAMESPACE::rigidbody::Contacts BIORBD_NAMESPACE::rigidbody::SoftContacts

Public Member Functions

 Model ()
 Construct an empty model that can be manually filled.
 Model (const utils::Path &path)
 Construct a model from a bioMod file.
rigidbody::ExternalForceSet externalForceSet (bool useLinearForces=true, bool useSoftContacts=true)
 Get an external forces set designed for the current model.
utils::Path path () const
 Returns the path of .bioMod file used to load the model. If no file was used, it remains empty.
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Joints
 Joints ()
 Construct a joint model.
 Joints (const Joints &other)
 Construct a joint model from another model.
virtual ~Joints ()
 Properly destroy class.
Joints DeepCopy () const
 Deep copy of the joints.
void DeepCopy (const Joints &other)
 Deep copy of the joints.
size_t AddSegment (const utils::String &segmentName, const utils::String &parentName, const utils::String &translationSequence, const utils::String &rotationSequence, const std::vector< utils::Range > &QRanges, const std::vector< utils::Range > &QdotRanges, const std::vector< utils::Range > &QddotRanges, const std::vector< utils::Scalar > &jointDampings, const SegmentCharacteristics &characteristics, const utils::RotoTrans &referenceFrame)
 Add a segment to the model.
size_t AddSegment (const utils::String &segmentName, const utils::String &parentName, const utils::String &translationSequence, const std::vector< utils::Range > &QRanges, const std::vector< utils::Range > &QdotRanges, const std::vector< utils::Range > &QddotRanges, const std::vector< utils::Scalar > &jointDampings, const SegmentCharacteristics &characteristics, const utils::RotoTrans &referenceFrame)
 Add a segment to the model.
utils::Vector3d getGravity () const
 Get the current gravity.
void setGravity (const utils::Vector3d &newGravity)
 Set the gravity.
int getBodyBiorbdId (const utils::String &segmentName) const
 Return the biorbd body identification.
int getBodyRbdlId (const utils::String &segmentName) const
 Return the rbdl body identification.
int getBodyRbdlIdToBiorbdId (const int idx) const
 Return the Biorbd body identification from rbdl.
size_t getBodyBiorbdIdToRbdlId (const int idx) const
 Return the Rbdl body identification from Biorbd.
std::vector< std::vector< size_t > > getDofSubTrees ()
 Return the rbdl idx of subtrees of each segments.
size_t nbGeneralizedTorque () const
 Return the number of generalized torque.
size_t nbSegment () const
 Return the actual number of segment.
size_t nbDof () const
 Return the number of degrees of freedom (DoF).
size_t getDofIndex (const utils::String &SegmentName, const utils::String &dofName)
 Return the index of a DoF in a segment.
std::vector< utils::String > nameDof () const
 Return the names of the degree of freedom (DoF).
size_t nbQ () const
 Return the number of generalized coordinates (Q).
size_t nbQdot () const
 Return the number of generalized velocities (Qdot).
size_t nbQddot () const
 Return the number of generalized acceleration (Qddot).
size_t nbRoot () const
 Return the dof on the root.
size_t nbQuat () const
 Return the number of segments that are described using quaternions.
void updateSegmentCharacteristics (size_t idx, const SegmentCharacteristics &characteristics)
 updateSegmentCharacteristics Change the inertia characteristics of the segment idx
Segment & segment (size_t idx)
 Get a segment of index idx.
Segment & segment (const utils::String &name)
 Get a segment of a specific name.
const Segment & segment (size_t idx) const
 Get a segment of index idx.
const Segment & segment (const utils::String &name) const
 Get a segment of a specific name.
std::vector< Segment > & segments () const
 Get all the segments.
GeneralizedTorque computeDampedTau (const GeneralizedVelocity &Qdot) const
 Get the joint dampings to apply to the dynamics.
Joints & UpdateKinematicsCustom (const GeneralizedCoordinates *Q=nullptr, const GeneralizedVelocity *Qdot=nullptr, const rigidbody::GeneralizedAcceleration *Qddot=nullptr)
 Update the kinematic variables such as body velocities and accelerations in the model to reflect the variables passed to this function.
std::vector< utils::RotoTrans > allGlobalJCS (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the joint coordinate system (JCS) in global reference frame at a given Q.
utils::RotoTrans globalJCS (const GeneralizedCoordinates &Q, const utils::String &name, bool updateKin=true)
 Return the joint coordinate system (JCS) for the segment in global reference frame at a given Q.
utils::RotoTrans globalJCS (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return the joint coordinate system (JCS) for the segment idx in global reference frame at a given Q.
std::vector< utils::RotoTrans > localJCS () const
 Return all the joint coordinate system (JCS) in its parent reference frame.
utils::RotoTrans localJCS (const utils::String &name) const
 Return the joint coordinate system (JCS) of the segment its parent reference frame.
utils::RotoTrans localJCS (const size_t idx) const
 Return the joint coordinate system (JCS) of the segment idx its parent reference frame.
utils::Vector3d CalcBodyToBaseCoordinates (const rigidbody::GeneralizedCoordinates &Q, utils::String segmentName, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcBodyToBaseCoordinates. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcBodyToBaseCoordinates (const rigidbody::GeneralizedCoordinates &Q, unsigned int bodyId, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcBodyToBaseCoordinates. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcPointVelocity (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, utils::String segmentName, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointVelocity. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcPointVelocity (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, unsigned int bodyId, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointVelocity. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::SpatialVector CalcPointVelocity6D (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, utils::String segmentName, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointVelocity6D. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::SpatialVector CalcPointVelocity6D (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, unsigned int bodyId, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointVelocity6D. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcPointAcceleration (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, utils::String segmentName, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointAcceleration. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcPointAcceleration (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, unsigned int bodyId, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointAcceleration. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Matrix CalcPointJacobian (const rigidbody::GeneralizedCoordinates &Q, utils::String segmentName, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointJacobian. Instead of sending the jacobian as an parameter, it is returned. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Matrix CalcPointJacobian (const rigidbody::GeneralizedCoordinates &Q, unsigned int bodyId, const utils::Vector3d &pointInLocal, bool updateKin=true)
 Interface to call CalcPointJacobian. Instead of sending the jacobian as an parameter, it is returned. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
NodeSegment projectPoint (const GeneralizedCoordinates &Q, const utils::Vector3d &v, int segmentIdx, const utils::String &axesToRemove, bool updateKin=true)
 Project a point on specific axis of a segment.
std::vector< NodeSegment > projectPoint (const GeneralizedCoordinates &Q, const std::vector< NodeSegment > &v, bool updateKin=true)
 Project multiples points on their respective segment.
NodeSegment projectPoint (const GeneralizedCoordinates &Q, const NodeSegment &n, bool updateKin)
 Return the projected markers from a point corresponding to a marker from the model.
utils::Matrix projectPointJacobian (const GeneralizedCoordinates &Q, NodeSegment node, bool updateKin)
 Return the jacobian matrix of the projected markers for a marker from the model.
utils::Matrix projectPointJacobian (const GeneralizedCoordinates &Q, const utils::Vector3d &v, int segmentIdx, const utils::String &axesToRemove, bool updateKin)
 Return the Jacobian matrix of a projected marker on the segment segmentIdx.
std::vector< utils::Matrix > projectPointJacobian (const GeneralizedCoordinates &Q, const std::vector< NodeSegment > &v, bool updateKin)
 Return the jacobian matrix of the projected markers.
utils::Scalar mass () const
 Return the total mass of the model.
utils::Vector3d CoM (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the position of the center of mass.
void CalcCenterOfMass (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration *Qddot, utils::Scalar &mass, utils::Vector3d &com, utils::Vector3d *comVelocity=NULL, utils::Vector3d *comAcceleration=NULL, utils::Vector3d *angularMomentum=NULL, utils::Vector3d *changeOfAngularMomentum=NULL, bool updateKin=true)
 Interface to CalcCenterOfMass. It is pretty much useless in Eigen, but fixes an issue in Casadi where RBDL changes internal variables which creates a free variables issue.
utils::Vector3d CalcZeroMomentPoint (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, bool updateKin=true)
 Compute the zero moment point on a contact surface.
utils::Vector3d CalcZeroMomentPoint (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, const utils::Vector3d &normal, const utils::Vector3d &point, bool updateKin=true)
 Compute the zero moment point on a contact surface.
std::vector< NodeSegment > CoMbySegment (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the position of the center of mass of each segment.
utils::Matrix CoMbySegmentInMatrix (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the position of the center of mass of each segment in a matrix.
utils::Vector3d CoMbySegment (const GeneralizedCoordinates &Q, const size_t idx, bool updateKin=true)
 Return the position of the center of mass of segment idx.
utils::Vector3d CoMdot (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Return the velocity of the center of mass.
utils::Vector3d CoMddot (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, bool updateKin=true)
 Return the acceleration of the center of mass.
std::vector< utils::Vector3d > CoMdotBySegment (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Return the velocity of the center of mass of each segment.
utils::Vector3d CoMdotBySegment (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const size_t idx, bool updateKin=true)
 Return the velocity of the center of mass of segment idx.
std::vector< utils::Vector3d > CoMddotBySegment (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, bool updateKin=true)
 Return the acceleration of the center of mass of each segment.
utils::Vector3d CoMddotBySegment (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, const size_t idx, bool updateKin=true)
 Return the acceleration of the center of mass of segment idx.
utils::Matrix CoMJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian matrix of the center of mass.
std::vector< std::vector< utils::Vector3d > > meshPoints (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the vertices of the mesh for all segments in global reference frame.
std::vector< utils::Vector3d > meshPoints (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return the vertices of the mesh for the segment idx.
std::vector< utils::Matrix > meshPointsInMatrix (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return all the vertices of the mesh points in a matrix.
std::vector< std::vector< MeshFace > > meshFaces () const
 Return the mesh faces for all the segments.
const std::vector< MeshFace > & meshFaces (size_t idx) const
 Return the mesh faces for segment idx.
std::vector< Mesh > mesh () const
 Return the segment mesh.
const Mesh & mesh (size_t idx) const
 Return the segment mesh for segment idx.
void overrideMeshFolders (const utils::String &folder)
 Set the folder for all the meshes.
utils::Vector3d angularMomentum (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Calculate the angular momentum of the center of mass. This method is an interface to CalcAngularMomemtum.
utils::Matrix massMatrix (const GeneralizedCoordinates &Q, bool updateKin=true)
 Get the mass matrix at a given position Q.
utils::Matrix massMatrixInverse (const rigidbody::GeneralizedCoordinates &Q, bool updateKin=true)
 Get the inverse mass matrix at a given position Q.
utils::Vector3d CalcAngularMomentum (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin)
 Calculate the angular momentum of the center of mass.
utils::Vector3d CalcAngularMomentum (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, bool updateKin)
 Calculate the angular momentum of the center of mass.
std::vector< utils::Vector3d > CalcSegmentsAngularMomentum (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin)
 Calculate the segment's contribution to the whole body angular momentum with respect to the global center of mass / formulae used: H_i = m_i * (r_i - r_com) x (v_i - v_com) + I_i * w_i) / The matrix returned contains a contribution for each last dof of a segment, zeros on all other DoFs.
std::vector< utils::Vector3d > CalcSegmentsAngularMomentum (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, bool updateKin)
 Calculate the segment's contribution to the whole body angular momentum with respect to the global center of mass / formulae used: H_i = m_i * (r_i - r_com) x (v_i - v_com) + I_i * w_i) / The matrix returned contains a contribution for each last dof of a segment, zeros on all other DoFs.
utils::Vector3d bodyAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Calculate the angular velocity of the model around its center of mass.
void CalcMatRotJacobian (const GeneralizedCoordinates &Q, size_t segmentIdx, const utils::Matrix3d &rotation, utils::Matrix &G, bool updateKin)
 Calculate the jacobian matrix of a rotation matrix.
utils::Matrix JacobianSegmentRotMat (const rigidbody::GeneralizedCoordinates &Q, size_t segmentIdx, bool updateKin)
 Calculate the jacobian matrix of a rotation matrix for a given segment idx.
GeneralizedVelocity computeQdot (const GeneralizedCoordinates &Q, const GeneralizedCoordinates &Qdot, const utils::Scalar &k_stab=1)
 Return the derivate of Q in function of Qdot (if not Quaternion, Qdot is directly returned).
utils::Vector3d segmentAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true)
 Return the angular velocity of the segment.
utils::Scalar KineticEnergy (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateKin=true)
 Interface for the Kinetic Energy of RBDL.
utils::Scalar PotentialEnergy (const rigidbody::GeneralizedCoordinates &Q, bool updateKin=true)
 Interface for the Potential Energy of RBDL.
utils::Scalar Lagrangian (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateKin=true)
 Compute the Lagrangian of the system.
utils::Scalar TotalEnergy (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateKin=true)
 Compute the Total Energy of System.
GeneralizedTorque InverseDynamics (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot)
 Interface for the inverse dynamics of RBDL.
GeneralizedTorque InverseDynamics (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, rigidbody::ExternalForceSet &externalForces)
 Interface for the inverse dynamics of RBDL.
GeneralizedTorque NonLinearEffect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot)
 Interface to NonLinearEffect.
GeneralizedTorque NonLinearEffect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, rigidbody::ExternalForceSet &externalForces)
 Interface to NonLinearEffect.
rigidbody::GeneralizedAcceleration ForwardDynamics (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau)
 Interface for the forward dynamics of RBDL.
rigidbody::GeneralizedAcceleration ForwardDynamics (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, rigidbody::ExternalForceSet &externalForces)
 Interface for the forward dynamics of RBDL.
rigidbody::GeneralizedAcceleration ForwardDynamicsFreeFloatingBase (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedAcceleration &QddotJoints)
 Biorbd's implementation of forward dynamics with a free floating base.
rigidbody::GeneralizedAcceleration ForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, bool updateKin=true)
 Interface for the forward dynamics with contact of RBDL.
rigidbody::GeneralizedAcceleration ForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, rigidbody::ExternalForceSet &externalForces, bool updateKin=true)
 Interface for the forward dynamics with contact of RBDL.
rigidbody::GeneralizedAcceleration ForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, Contacts &CS, bool updateKin=true)
 Interface for the forward dynamics with contact of RBDL.
rigidbody::GeneralizedAcceleration ForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, Contacts &CS, rigidbody::ExternalForceSet &externalForces, bool updateKin=true)
 Interface for the forward dynamics with contact of RBDL.
utils::Vector ContactForcesFromForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau)
 Interface for contacts of the forward dynamics with contact of RBDL.
utils::Vector ContactForcesFromForwardDynamicsConstraintsDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const GeneralizedTorque &Tau, rigidbody::ExternalForceSet &externalForces)
 Interface for contacts of the forward dynamics with contact of RBDL.
utils::Matrix3d bodyInertia (const rigidbody::GeneralizedCoordinates &Q, bool updateKin=true)
 bodyInertia Return the matrix of inertia of the body expressed in the global reference frame computed at the center of mass
GeneralizedVelocity ComputeConstraintImpulsesDirect (const GeneralizedCoordinates &Q, const GeneralizedVelocity &QdotPre)
 Compute the Qdot post from an impact.
void checkGeneralizedDimensions (const GeneralizedCoordinates *Q=nullptr, const GeneralizedVelocity *Qdot=nullptr, const rigidbody::GeneralizedAcceleration *Qddot=nullptr, const GeneralizedTorque *torque=nullptr)
 Check for the Generalized coordinates, velocities, acceleration and torque dimensions.
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Markers
 Markers ()
 Construct a marker set.
 Markers (const Markers &other)
 Construct markers from another marker set.
virtual ~Markers ()
 Destroy class properly.
Markers DeepCopy () const
 Deep copy of the markers.
void DeepCopy (const Markers &other)
 Deep copy of the markers.
void addMarker (const NodeSegment &pos, const utils::String &name, const utils::String &parentName, bool technical, bool anatomical, const utils::String &axesToRemove, int id=-1)
 Add a marker to the set.
void setMarker (size_t index, const NodeSegment &pos)
 Change the values of a specific marker without changing other parameters.
std::vector< utils::String > markerNames () const
 Return the names of all the markers.
std::vector< utils::String > technicalMarkerNames () const
 Return the names of all the technical markers.
std::vector< utils::String > anatomicalMarkerNames () const
 Return the names of all the anatomical markers.
const NodeSegment & marker (size_t idx) const
 Return a marker of index idx in the marker set.
NodeSegment markerAxesRemoved (size_t idx) const
 Return a marker of index idx in the marker set with the axes removed.
NodeSegment marker (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const NodeSegment &node, bool removeAxis=true)
 Compute and return the position of a marker at given Q in the global reference frame.
NodeSegment marker (const GeneralizedCoordinates &Q, const NodeSegment &node, bool updateKin=true, bool removeAxis=true)
 Compute and return the position of a marker at given Q in the global reference frame.
NodeSegment marker (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, size_t idx, bool removeAxis=true)
 Compute and return the position of the marker of index idx at given Q in the global reference frame.
NodeSegment marker (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true, bool removeAxis=true)
 Compute and return the position of the marker of index idx at given Q in the global reference frame.
std::vector< NodeSegment > markers (bool removeAxis=true) const
 Return a copy of all the markers in their respective parent reference frame.
std::vector< NodeSegment > markers (const utils::String &segmentName, bool removeAxis=true) const
 Return the markers on a segment.
std::vector< NodeSegment > markers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the markers at a given Q in the global reference frame.
std::vector< NodeSegment > markers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the markers at a given Q in the global reference frame.
NodeSegment markerVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool removeAxis=true)
 Return the linear velocity of a marker.
NodeSegment markerVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the linear velocity of a marker.
NodeSegment markerAngularVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool removeAxis=true)
 Return the angular velocity of a marker.
NodeSegment markerAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the angular velocity of a marker.
std::vector< NodeSegment > markersVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool removeAxis=true)
 Return the linear velocity of all the markers.
std::vector< NodeSegment > markersVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true, bool removeAxis=true)
 Return the linear velocity of all the markers.
std::vector< NodeSegment > markersAngularVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool removeAxis=true)
 Return the angular velocity of all the markers.
std::vector< NodeSegment > markersAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true, bool removeAxis=true)
 Return the angular velocity of all the markers.
NodeSegment markerAcceleration (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, size_t idx, bool removeAxis=true)
 Return the acceleration of a marker.
NodeSegment markerAcceleration (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the acceleration of a marker.
std::vector< NodeSegment > markerAcceleration (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, bool removeAxis=true)
 Return the acceleration of all the markers.
std::vector< NodeSegment > markerAcceleration (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, bool updateKin=true, bool removeAxis=true)
 Return the acceleration of all the markers.
std::vector< NodeSegment > technicalMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the technical markers at a given Q in the global reference frame.
std::vector< NodeSegment > technicalMarkers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the technical markers at a given Q in the global reference frame.
std::vector< NodeSegment > technicalMarkers () const
 Return the technical markers in their respective parent reference frame.
std::vector< NodeSegment > technicalMarkersAxesRemoved () const
 Return the technical markers in their respective parent reference frame.
std::vector< NodeSegment > anatomicalMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the anatomical markers at a given Q in the global reference frame.
std::vector< NodeSegment > anatomicalMarkers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the anatomical markers at a given Q in the global reference frame.
std::vector< NodeSegment > anatomicalMarkers () const
 Return the anatomical markers in their respective parent reference frame.
std::vector< NodeSegment > anatomicalMarkersAxesRemoved () const
 Return the anatomical markers in their respective parent reference frame.
std::vector< NodeSegment > segmentMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, size_t idx, bool removeAxis=true)
 Return all the markers of the segment idx at a given Q in the global reference frame.
std::vector< NodeSegment > segmentMarkers (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return all the markers of the segment idx at a given Q in the global reference frame.
size_t nbMarkers () const
 Return the number of markers.
size_t nbMarkers (size_t idxSegment) const
 Return the number of markers on the segment idxSegment.
size_t nbTechnicalMarkers ()
 Return the number of technical markers.
size_t nbTechnicalMarkers (size_t idxSegment)
 Return the number of technical markers on the segment idxSegment.
size_t nbAnatomicalMarkers ()
 Return the number of anatomical markers.
std::vector< utils::Matrix > markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return the jacobian of the markers.
std::vector< utils::Matrix > markersJacobian (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of the markers.
std::vector< utils::Matrix > technicalMarkersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return the jacobian of the technical markers.
std::vector< utils::Matrix > technicalMarkersJacobian (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of the technical markers.
utils::Matrix markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const utils::String &parentName, const NodeSegment &p, bool removeAxis=true)
 Return the jacobian of a chosen marker.
utils::Matrix markersJacobian (const GeneralizedCoordinates &Q, const utils::String &parentName, const NodeSegment &p, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of a chosen marker.
bool inverseKinematics (const std::vector< NodeSegment > &markers, const GeneralizedCoordinates &Qinit, GeneralizedCoordinates &Q, bool removeAxis=true)
 Performs an inverse kinematics.
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::IMUs
 IMUs ()
 Construct inertial measurement units set.
 IMUs (const IMUs &other)
 Construct inertial measurement units set from another set.
virtual ~IMUs ()
 Destroy the class properly.
IMUs DeepCopy () const
 Deep copy of the inertial measurement units data.
void DeepCopy (const IMUs &other)
 Deep copy the inertial measurement units data.
void addIMU (bool technical=true, bool anatomical=true)
 Add a new inertial measurement unit to the set.
void addIMU (const utils::RotoTransNode &RotoTrans, bool technical=true, bool anatomical=true)
 Add a new inertial measurement unit to the set.
size_t nbIMUs () const
 Return the number of inertial measurement units (IMU) in the set.
std::vector< utils::String > IMUsNames ()
 Return the names of the inertial measurement units (IMU).
std::vector< utils::String > technicalIMUsNames ()
 Return the names of the technical inertial measurement units (IMU).
std::vector< utils::String > anatomicalIMUsNames ()
 Return the names of the anatomical inertial measurement units (IMU).
const std::vector< rigidbody::IMU > & IMU () const
 Return all the IMU in the local reference of the segment.
std::vector< rigidbody::IMU > IMU (const utils::String &segmentName)
 Return all the inertial measurement units (IMU) of a segment.
const rigidbody::IMU & IMU (size_t idx)
 Return the inertial measurement unit (IMU) of a specified index.
std::vector< rigidbody::IMU > IMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Compute and return all the inertial measurement units (IMU) at the position given by Q.
rigidbody::IMU IMU (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Compute and return one inertial meausrement unit (IMU) at the position given by Q.
std::vector< rigidbody::IMU > segmentIMU (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return all the inertial measurement units (IMU) on a specified segment.
size_t nbTechIMUs ()
 Return the number of technical inertial measurement units (IMU).
size_t nbAnatIMUs ()
 Return the number of anatomical inertial measurement units (IMU).
std::vector< rigidbody::IMU > technicalIMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return all the technical inertial measurement units (IMU).
std::vector< rigidbody::IMU > technicalIMU ()
 Return all the technical inertial measurement units (IMU) in their respective segment local reference frame.
std::vector< rigidbody::IMU > anatomicalIMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return all the anatomical inertial measurement units (IMU).
std::vector< rigidbody::IMU > anatomicalIMU ()
 Return all the anatomical inertial measurement units (IMU) in their respective segment local reference frame.
std::vector< utils::Matrix > IMUJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the inertial measurement units (IMU).
std::vector< utils::Matrix > TechnicalIMUJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the technical inertial measurement units (IMU).
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::RotoTransNodes
 RotoTransNodes ()
 Construct RT set.
 RotoTransNodes (const RotoTransNodes &other)
 Construct RTs set from another set.
virtual ~RotoTransNodes ()
 Destroy the class properly.
RotoTransNodes DeepCopy () const
 Deep copy of the RTs data.
void DeepCopy (const RotoTransNodes &other)
 Deep copy the RTs data.
void addRT ()
 Add a new RT to the set.
virtual void addRT (const utils::RotoTransNode &RotoTrans)
 Add a new RT to the set.
size_t nbRTs () const
 Return the number of RTs in the set.
size_t size () const
 Return the number of RTs in the set.
std::vector< utils::String > RTsNames ()
 Return the names of the RTs.
const std::vector< utils::RotoTransNode > & RTs () const
 Return all the RTs in the local reference of the segment.
std::vector< utils::RotoTransNode > RTs (const utils::String &segmentName)
 Return all the RTs of a segment.
const utils::RotoTransNode & RT (size_t idx)
 Return the RTs of a specified index.
std::vector< utils::RotoTransNode > RTs (const GeneralizedCoordinates &Q, bool updateKin=true)
 Compute and return all the RTs at the position given by Q.
utils::RotoTransNode RT (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Compute and return the RT of index idx at the position given by Q.
std::vector< utils::RotoTransNode > segmentRTs (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return all the RTs on a specified segment.
std::vector< utils::Matrix > RTsJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the RTs.
virtual void clear ()
 Return to an internal state similar to initial declaration.
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Contacts
 Contacts ()
 Construct contacts.
Contacts DeepCopy () const
 Deep copy of contacts.
void DeepCopy (const Contacts &other)
 Deep copy of contacts.
size_t AddConstraint (size_t bodyId, const utils::Vector3d &bodyPoint, const utils::Vector3d &worldNormal, const utils::String &name, const utils::String &parentName)
 Add a constraint to the constraint set.
size_t AddConstraint (size_t bodyId, const utils::Vector3d &bodyPoint, const utils::String &axis, const utils::String &name, const utils::String &parentName)
 Add a constraint to the constraint set.
size_t AddLoopConstraint (size_t body_id_predecessor, size_t body_id_successor, const utils::RotoTrans &X_predecessor, const utils::RotoTrans &X_successor, const utils::SpatialVector &axis, const utils::String &name, bool enableStabilization=false, double stabilizationParam=0.1)
 Add a loop constraint to the constraint set.
std::vector< utils::SpatialVector > calcLoopConstraintForces (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedTorque &Tau)
 compute the forces generated from loop constraints
std::vector< utils::SpatialVector > calcLoopConstraintForces (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedTorque &Tau, rigidbody::ExternalForceSet &externalForces)
 compute the forces generated from loop constraints
virtual ~Contacts ()
 Destroy the class properly.
Contacts & getConstraints ()
 Get constraints.
bool hasContacts () const
 Check if there are contacts.
bool hasLoopConstraints () const
 Check if there are loop constraints.
size_t nbContacts () const
 Return the number of contacts.
size_t nbLoopConstraints () const
 Return the number of loop constraints.
std::vector< utils::String > contactNames ()
 Return the name of the all contacts.
utils::String contactName (size_t i)
 Return the name of the contact of a specified axis.
size_t contactRbdlId (const utils::String &name)
 Return the index of the contact corresponding to the given name.
std::vector< utils::Vector3d > constraintsInGlobal (const GeneralizedCoordinates &Q, bool updateKin)
 Return the constraints position in the global reference.
utils::Vector getForce () const
 Return the force acting on the constraint.
int contactSegmentBiorbdId (int idx) const
 Return the segment idx of the contact in biorbd formalism.
std::vector< size_t > segmentRigidContactIdx (int segment_idx) const
 Return the index of rigid contacts for a specified segment index.
int nbRigidContacts () const
 Returns the number of rigid contacts (ignoring the loop constraints).
const std::vector< NodeSegment > & rigidContacts () const
 Returns all the rigid contacts as declared in the model.
const NodeSegment & rigidContact (size_t idx) const
 Returns the rigid contact idx as declared in the model.
utils::Vector3d rigidContact (const GeneralizedCoordinates &Q, size_t idx, bool updateKin)
 Return the rigidContact position in the global reference.
std::vector< utils::Vector3d > rigidContacts (const GeneralizedCoordinates &Q, bool updateKin)
 Return all the rigidContacts position in the global reference.
utils::Vector3d rigidContactVelocity (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true)
 Return the velocity of the chosen contact.
std::vector< utils::Vector3d > rigidContactsVelocity (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, bool updateKin=true)
 Return the velocities of all the contacts.
utils::Vector3d rigidContactAcceleration (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, size_t idx, bool updateKin=true)
 Return the acceleration of the chosen contact.
std::vector< utils::Vector3d > rigidContactsAcceleration (const rigidbody::GeneralizedCoordinates &Q, const rigidbody::GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, bool updateKin=true)
 Return the acceleration of all the contacts.
utils::Matrix rigidContactJacobian (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q, size_t idx)
 Compute the Jacobian of a single rigid contact.
utils::Matrix rigidContactJacobian (const rigidbody::GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Compute the Jacobian of a single rigid contact.
std::vector< utils::Matrix > rigidContactsJacobian (rigidbody::Joints &updatedModel, const rigidbody::GeneralizedCoordinates &Q)
 Compute the Jacobians of all rigid contacts.
std::vector< utils::Matrix > rigidContactsJacobian (const rigidbody::GeneralizedCoordinates &Q, bool updateKin=true)
 Compute the Jacobians of all rigid contacts.
Public Member Functions inherited from BIORBD_NAMESPACE::rigidbody::SoftContacts
 SoftContacts ()
 Construct a contact biorbd set.
virtual ~SoftContacts ()
 Virtual destructor.
SoftContacts DeepCopy () const
 Deep copy of the contacts.
void DeepCopy (const SoftContacts &other)
 Deep copy of the contacts.
utils::String softContactName (size_t i)
 Return the name of the soft contact.
std::vector< utils::String > softContactNames ()
 Return the names of the soft contact.
void addSoftContact (const SoftContactNode &contact)
 Add a new contact to the contact set.
SoftContactNode & softContact (size_t idx)
 Return a specified contact.
NodeSegment softContact (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return a specified contact at a given position Q.
std::vector< NodeSegment > softContacts (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return a the contacts at a given position Q.
NodeSegment softContactVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true)
 Return the linear velocity of a contact.
NodeSegment softContactAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true)
 Return the angular velocity of a contact.
std::vector< NodeSegment > softContactsVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Return the velocity of all the contacts.
std::vector< NodeSegment > softContactsAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true)
 Return the angular velocity of all the contacts.
size_t nbSoftContacts () const
 Return the number of contacts.
std::vector< size_t > segmentSoftContactIdx (size_t idx) const
 Return all the soft contacts indices of a segment.

Additional Inherited Members

Protected Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Joints
std::vector< std::vector< size_t > > recursiveDofSubTrees (std::vector< std::vector< size_t > > subTrees, size_t idx)
 Return the rbdl idx of subtrees of each segments.
utils::SpatialTransform CalcBodyWorldTransformation (const GeneralizedCoordinates &Q, const size_t segmentIdx, bool updateKin=true)
 Calculate the joint coordinate system (JCS) in global reference frame of a specified segment.
std::vector< utils::Vector3d > meshPoints (const std::vector< utils::RotoTrans > &RT, size_t idx) const
 Return the mesh vertices of segment idx.
Protected Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Markers
std::vector< utils::Matrix > markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool lookForTechnical, bool removeAxis)
 Compute the jacobian of the markers.
Protected Member Functions inherited from BIORBD_NAMESPACE::rigidbody::IMUs
std::vector< utils::Matrix > IMUJacobian (const GeneralizedCoordinates &Q, bool updateKin, bool lookForTechnical)
 Compute and return the jacobian of all the inertial measurement units (IMU).
Protected Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Contacts
utils::String swapAxes (const utils::String &axesToSwap) const
 Swap the status of the axes provided, that is adding x, y or z if it is not there and remove them otherwise. This effectively transform an allowed axes set to a axes to remove set, or vice versa.
Static Protected Member Functions inherited from BIORBD_NAMESPACE::rigidbody::Contacts
static utils::Matrix projectContactJacobian (const utils::Matrix &J, const rigidbody::NodeSegment &contact)
 Project a 3D point Jacobian onto active contact axes.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::Joints
std::shared_ptr< std::vector< Segment > > m_segments
 All the articulations.
std::shared_ptr< size_t > m_nbRoot
 The number of DoF on the root segment.
std::shared_ptr< size_t > m_nbDof
 The total number of degrees of freedom.
std::shared_ptr< size_t > m_nbQ
 The total number of Q.
std::shared_ptr< size_t > m_nbQdot
 The total number of Qdot.
std::shared_ptr< size_t > m_nbQddot
 The total number of Qddot.
std::shared_ptr< size_t > m_nRotAQuat
 The number of segments per quaternion.
std::shared_ptr< bool > m_isKinematicsComputed
 If the kinematics are computed.
std::shared_ptr< utils::Scalar > m_totalMass
 Mass of all the bodies combined.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::Markers
std::shared_ptr< std::vector< NodeSegment > > m_marks
 The markers.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::IMUs
std::shared_ptr< std::vector< rigidbody::IMU > > m_IMUs
 All the inertial Measurement Units.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::RotoTransNodes
std::shared_ptr< std::vector< utils::RotoTransNode > > m_RTs
 All the RTs.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::Contacts
std::shared_ptr< size_t > m_nbreConstraint
 Number of constraints.
std::shared_ptr< bool > m_isBinded
 If the model is ready.
std::shared_ptr< std::vector< rigidbody::NodeSegment > > m_rigidContacts
std::shared_ptr< size_t > m_nbLoopConstraint
 Number of constraints.
Protected Attributes inherited from BIORBD_NAMESPACE::rigidbody::SoftContacts
std::shared_ptr< std::vector< std::shared_ptr< SoftContactNode > > > m_softContacts
 The contacts.

Detailed Description

The actual musculoskeletal model that holds everything in biorbd.

Definition at line 79 of file BiorbdModel.h.

Constructor & Destructor Documentation

◆ Model() [1/2]

Model::Model ( )

Construct an empty model that can be manually filled.

Definition at line 18 of file BiorbdModel.cpp.

◆ Model() [2/2]

Model::Model ( const utils::Path & path)

Construct a model from a bioMod file.

Parameters
pathThe path of the file

Definition at line 20 of file BiorbdModel.cpp.

Member Function Documentation

◆ externalForceSet()

rigidbody::ExternalForceSet Model::externalForceSet ( bool useLinearForces = true,
bool useSoftContacts = true )

Get an external forces set designed for the current model.

Parameters
useLinearForcesIf this force set has external forces
useSoftContactsIf this force set has soft contacts
Returns
The external forces set

Definition at line 27 of file BiorbdModel.cpp.

◆ path()

utils::Path Model::path ( ) const

Returns the path of .bioMod file used to load the model. If no file was used, it remains empty.

Returns
The path of .bioMod file used to load the model

Definition at line 25 of file BiorbdModel.cpp.


The documentation for this class was generated from the following files: