Skip to content

Commit

Permalink
udate api doc for resolving auto inertia
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Chen <[email protected]>
  • Loading branch information
iche033 committed Dec 9, 2024
1 parent d0fdc9c commit d529d12
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions include/sdf/Link.hh
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,12 @@ namespace sdf
const std::string &_resolveTo = "") const;

/// \brief Calculate & set inertial values(mass, mass matrix
/// & inertial pose) for the link. Inertial values can be provided
/// by the user through the SDF or can be calculated automatically
/// by setting the auto attribute to true.
/// & inertial pose) for the link. This function will calculate
/// the inertial values if the auto attribute is set to true.
/// If mass is not provided by the user, the inertial values will be
/// determined based on either link density or collision density if
/// explicitly set. Otherwise, if mass is specified, the inertia matrix
/// will be scaled to match the desired mass.
/// \param[out] _errors A vector of Errors object. Each object
/// would contain an error code and an error message.
/// \param[in] _config Custom parser configuration
Expand Down

0 comments on commit d529d12

Please sign in to comment.