SetFixedJointWeldChildToParentFeature::Joint< PolicyT, FeaturesT > Class Template Reference
The Joint API for setting whether to weld a fixed joint's child link to the parent link. More...
#include <Joint.hh>
Public Member Functions | |
| void | SetWeldChildToParent (bool _weldChildToParent) |
| Set whether to weld the fixed joint's child link to the parent link. If true, the child link is welded and it will move / with the parent link as if they are part of the same body kinematic chain. If false, the fixed joint constraint is enforced by applying forces to both the parent and child links. By default when a fixed joint constraint is created, this property is set to false. | |
 Public Member Functions inherited from Feature::Joint< PolicyT, FeaturesT > | |
| virtual | ~Joint ()=default |
| Virtual destructor. | |
| Public Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| virtual | ~Entity ()=default |
| Virtual destructor. | |
| std::size_t | EntityID () const |
| Get the unique ID value of this Entity. | |
| const std::shared_ptr< void > & | EntityReference () const |
| Get a reference-counting std::shared_ptr to the object inside the implementation that this object provides an abstraction for. | |
| const Identity & | FullIdentity () const |
| Get the Identity object of this Entity. | |
Additional Inherited Members | |
| Public Types inherited from Entity< PolicyT, FeaturesT > | |
| using | Features = FeaturesT |
| using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
| using | Policy = PolicyT |
| Protected Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| Entity (const std::shared_ptr< Pimpl > &_pimpl=nullptr, const Identity &_identity=Identity()) | |
| Constructor for the Entity. | |
| Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity) | |
| Constructor that allows the pimpl to be moved instead of copied. | |
| template<typename FeatureT > | |
| FeatureT::template Implementation< PolicyT > * | Interface () |
| Get a pointer to the implementation of FeatureT. | |
| template<typename FeatureT > | |
| const FeatureT::template Implementation< PolicyT > * | Interface () const |
| Same as Interface(), but const-qualified so that const entities can request const-qualified interfaces from the implementation. | |
| Protected Attributes inherited from Entity< PolicyT, FeaturesT > | |
| Identity | identity |
| This field contains information to identify the entity. | |
| std::shared_ptr< Pimpl > | pimpl |
| This is a pointer to the physics engine implementation, and it can be used by the object features to find the interfaces that they need in order to function. | |
Detailed Description
template<typename PolicyT, typename FeaturesT>
class gz::physics::SetFixedJointWeldChildToParentFeature::Joint< PolicyT, FeaturesT >
class gz::physics::SetFixedJointWeldChildToParentFeature::Joint< PolicyT, FeaturesT >
The Joint API for setting whether to weld a fixed joint's child link to the parent link.
Member Function Documentation
◆ SetWeldChildToParent()
template<typename PolicyT , typename FeaturesT >
| void SetWeldChildToParent | ( | bool | _weldChildToParent | ) |
Set whether to weld the fixed joint's child link to the parent link. If true, the child link is welded and it will move / with the parent link as if they are part of the same body kinematic chain. If false, the fixed joint constraint is enforced by applying forces to both the parent and child links. By default when a fixed joint constraint is created, this property is set to false.
- Parameters
-
[in] _weldChildToParent True to weld the child link to the parent link.
The documentation for this class was generated from the following file: