Gazebo Physics

API Reference

8.0.0~pre2
GetShapeFromLink::Shape< PolicyT, FeaturesT > Class Template Reference

#include <GetEntities.hh>

Public Types

using ConstLinkPtrType = ConstLinkPtr< PolicyT, FeaturesT >
 
using LinkPtrType = LinkPtr< 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

std::size_t GetIndex () const
 Get the index of this Shape within its Link.
 
LinkPtrType GetLink ()
 Get the Link that contains this Shape.
 
ConstLinkPtrType GetLink () const
 
const std::stringGetName () const
 Get the name of this Shape.
 
- Public Member Functions inherited from Feature::Shape< PolicyT, FeaturesT >
virtual ~Shape ()=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< 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.
 

Member Typedef Documentation

◆ ConstLinkPtrType

template<typename PolicyT , typename FeaturesT >
using ConstLinkPtrType = ConstLinkPtr<PolicyT, FeaturesT>

◆ LinkPtrType

template<typename PolicyT , typename FeaturesT >
using LinkPtrType = LinkPtr<PolicyT, FeaturesT>

Member Function Documentation

◆ GetIndex()

template<typename PolicyT , typename FeaturesT >
std::size_t GetIndex ( ) const

Get the index of this Shape within its Link.

◆ GetLink() [1/2]

template<typename PolicyT , typename FeaturesT >
LinkPtrType GetLink ( )

Get the Link that contains this Shape.

Returns
a Link reference to the Link that contains this Shape.

◆ GetLink() [2/2]

template<typename PolicyT , typename FeaturesT >
ConstLinkPtrType GetLink ( ) const
See also
GetLink()

◆ GetName()

template<typename PolicyT , typename FeaturesT >
const std::string & GetName ( ) const

Get the name of this Shape.


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