AttachCapsuleShapeFeature::Link< PolicyT, FeaturesT > Class Template Reference
#include <CapsuleShape.hh>
Public Types | |
| using | PoseType = typename FromPolicy< PolicyT >::template Use< Pose > |
| using | Scalar = typename PolicyT::Scalar |
| using | ShapePtrType = CapsuleShapePtr< PolicyT, FeaturesT > |
Public Types inherited from Entity< PolicyT, FeaturesT > | |
| using | Features = FeaturesT |
| using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
| using | Policy = PolicyT |
Public Member Functions | |
| ShapePtrType | AttachCapsuleShape (const std::string &_name="capsule", Scalar _radius=0.5, Scalar _length=1.0, const PoseType &_pose=PoseType::Identity()) |
| Rigidly attach a CapsuleShape to this link. | |
Public Member Functions inherited from Feature::Link< PolicyT, FeaturesT > | |
| virtual | ~Link ()=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 | |
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. | |
Member Typedef Documentation
◆ PoseType
template<typename PolicyT , typename FeaturesT >
| using PoseType = typename FromPolicy<PolicyT>::template Use<Pose> |
◆ Scalar
template<typename PolicyT , typename FeaturesT >
| using Scalar = typename PolicyT::Scalar |
◆ ShapePtrType
template<typename PolicyT , typename FeaturesT >
| using ShapePtrType = CapsuleShapePtr<PolicyT, FeaturesT> |
Member Function Documentation
◆ AttachCapsuleShape()
template<typename PolicyT , typename FeaturesT >
| ShapePtrType AttachCapsuleShape | ( | const std::string & | _name = "capsule", |
| Scalar | _radius = 0.5, |
||
| Scalar | _length = 1.0, |
||
| const PoseType & | _pose = PoseType::Identity() |
||
| ) |
Rigidly attach a CapsuleShape to this link.
- Parameters
-
[in] _radius The radius of the capsule. [in] _length The length of the capsule. [in] _pose The desired pose of the CapsuleShape relative to the Link frame.
- Returns
- a ShapePtrType to the newly constructed CapsuleShape
The documentation for this class was generated from the following file:
Public Types inherited from