Ignition Physics

API Reference

5.1.0
AttachPrismaticJointFeature::Implementation< PolicyT > Class Template Referenceabstract

#include <PrismaticJoint.hh>

Public Types

using Axis = typename FromPolicy< PolicyT >::template Use< LinearVector >
 

Public Member Functions

virtual Identity AttachPrismaticJoint (const Identity &_childID, const BaseLinkPtr< PolicyT > &_parent, const std::string &_name, const Axis &_axis)=0
 
- Public Member Functions inherited from Feature::Implementation< PolicyT >
virtual ~Implementation ()=default
 Virtual destructor. More...
 
virtual Identity InitiateEngine (std::size_t engineID=0)=0
 Tell the physics plugin to initiate a physics engine. More...
 

Member Typedef Documentation

◆ Axis

using Axis = typename FromPolicy<PolicyT>::template Use<LinearVector>

Member Function Documentation

◆ AttachPrismaticJoint()

virtual Identity AttachPrismaticJoint ( const Identity &  _childID,
const BaseLinkPtr< PolicyT > &  _parent,
const std::string _name,
const Axis _axis 
)
pure virtual
Parameters
[in]_childIDThe ID of the child link.
[in]_parentA reference to the parent link. If this evaluates to a nullptr, then the parent should be the world.
[in]_nameThe name for this joint.
[in]_axisThe desired axis of the new revolute joint
Returns
the Identity of the newly created PrismaticJoint

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