Skip to content

Commit

Permalink
expand API doc
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Chen <[email protected]>
  • Loading branch information
iche033 committed Jul 23, 2024
1 parent d4ce506 commit c2e2f40
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions include/gz/physics/Kinematic.hh
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,15 @@ namespace gz
class Link : public virtual Feature::Link<PolicyT, FeaturesT>
{
/// \brief Set link to be kinematic.
/// A kinematic link does not react to forces, e.g. gravity or other dynamic
/// objects. It reacts to pose or velocity commands that are set on the link
/// (via a FreeGroup) or on the joint that connects the kinematic links.
/// \param[i] _kinematic True to make this link kinematic.
public: void SetKinematic(bool _kinematic);

/// \brief Get whether this link is kinematic.
/// \return True if the link is kinematic, false otherwise.
/// \sa SetKinematic
public: bool GetKinematic() const;
};

Expand Down

0 comments on commit c2e2f40

Please sign in to comment.