Ignition Physics

API Reference

1.2.0
FreeGroupFrameSemantics Class Reference

This feature provides an interface between the Model and Link classes and the FreeGroup class, which represents a group of links that are not connected to the world with any kinematic constraints. A FreeGroup can represent a single connected group of links that forms a tree with the root of the tree connected to the world with a FreeJoint, but it can also represent a group of other FreeGroups. Each FreeGroup has 1 canonical link, whose frame is used for getting and setting properties like pose and velocity. If the FreeGroup is a single tree of connected links, the canonical link should be the root of that tree. If the FreeGroup contains multiple FreeGroups, the canonical link should be selected from one of the component FreeGroups. More...

#include <FreeGroup.hh>

Public Types

template<typename PolicyT , typename FeaturesT >
using FreeGroup = FrameSemantics::Frame< PolicyT, FeaturesT >
 
- Public Types inherited from FeatureWithRequirements< FindFreeGroupFeature, FrameSemantics >
using RequiredFeatures = FeatureList< Features... >
 
- Public Types inherited from Feature
using RequiredFeatures = void
 By default, a blank feature will not require any other features. If your feature does require some other set of features, then you should inherit the FeatureWithRequirements class, and provide it with a list of the Features that you require. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Feature
template<typename SomeFeatureList , bool = false>
static constexpr bool ConflictsWith ()
 By default, a blank feature will not conflict with any other features. If your feature does conflict with some other set of features, then you should inherit the FeatureWithConflicts<...> class, and provide it a list of those conflicting features. More...
 

Detailed Description

This feature provides an interface between the Model and Link classes and the FreeGroup class, which represents a group of links that are not connected to the world with any kinematic constraints. A FreeGroup can represent a single connected group of links that forms a tree with the root of the tree connected to the world with a FreeJoint, but it can also represent a group of other FreeGroups. Each FreeGroup has 1 canonical link, whose frame is used for getting and setting properties like pose and velocity. If the FreeGroup is a single tree of connected links, the canonical link should be the root of that tree. If the FreeGroup contains multiple FreeGroups, the canonical link should be selected from one of the component FreeGroups.

Member Typedef Documentation

◆ FreeGroup

using FreeGroup = FrameSemantics::Frame<PolicyT, FeaturesT>

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