Gazebo Physics

API Reference

5.3.2
SetRevoluteJointProperties::RevoluteJoint< PolicyT, FeaturesT > Class Template Reference

The API for setting basic revolute joint properties. More...

#include <RevoluteJoint.hh>

Public Types

using Axis = typename FromPolicy< PolicyT >::template Use< AngularVector >
 
- Public Types inherited from Entity< PolicyT, FeaturesT >
using Features = FeaturesT
 
using Pimpl = typename detail::DeterminePlugin< Policy, Features >::type
 
using Policy = PolicyT
 

Public Member Functions

void SetAxis (const Axis &_axis)
 Set the axis of this RevoluteJoint. More...
 
- Public Member Functions inherited from Entity< PolicyT, FeaturesT >
virtual ~Entity ()=default
 Virtual destructor. More...
 
std::size_t EntityID () const
 Get the unique ID value of this Entity. More...
 
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. More...
 
const Identity & FullIdentity () const
 Get the Identity object of this Entity. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Entity< PolicyT, FeaturesT >
 Entity (const std::shared_ptr< Pimpl > &_pimpl=nullptr, const Identity &_identity=Identity())
 Constructor for the Entity. More...
 
 Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity)
 Constructor that allows the pimpl to be moved instead of copied. More...
 
template<typename FeatureT >
FeatureT::template Implementation< PolicyT > * Interface ()
 Get a pointer to the implementation of FeatureT. More...
 
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. More...
 
- Protected Attributes inherited from Entity< PolicyT, FeaturesT >
Identity identity
 This field contains information to identify the entity. More...
 
std::shared_ptr< Pimplpimpl
 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. More...
 

Detailed Description

template<typename PolicyT, typename FeaturesT>
class ignition::physics::SetRevoluteJointProperties::RevoluteJoint< PolicyT, FeaturesT >

The API for setting basic revolute joint properties.

Member Typedef Documentation

◆ Axis

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

Member Function Documentation

◆ SetAxis()

void SetAxis ( const Axis _axis)

Set the axis of this RevoluteJoint.

For 3D simulations, this expects a 3D vector.

For 2D simulations, this expects a 1D "vector" (essentially a scalar, but its value must be accessed from the first element). It is recommended that you only pass a value of +1.0 or -1.0. Physics engines might not normalize the value before using it.


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