Gazebo Physics

API Reference

8.0.0
AttachHeightmapShapeFeature::Link< PolicyT, FeaturesT > Class Template Reference

#include <HeightmapShape.hh>

Public Types

using Dimensions = typename FromPolicy< PolicyT >::template Use< LinearVector >
 
using PoseType = typename FromPolicy< PolicyT >::template Use< Pose >
 
using ShapePtrType = HeightmapShapePtr< 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 AttachHeightmapShape (const std::string &_name, const common::HeightmapData &_heightmapData, const PoseType &_pose, const Dimensions &_size, int _subSampling=1)
 Attach a heightmap shape to a link.
 
- 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

◆ Dimensions

template<typename PolicyT , typename FeaturesT >
using Dimensions = typename FromPolicy<PolicyT>::template Use<LinearVector>

◆ PoseType

template<typename PolicyT , typename FeaturesT >
using PoseType = typename FromPolicy<PolicyT>::template Use<Pose>

◆ ShapePtrType

template<typename PolicyT , typename FeaturesT >
using ShapePtrType = HeightmapShapePtr<PolicyT, FeaturesT>

Member Function Documentation

◆ AttachHeightmapShape()

template<typename PolicyT , typename FeaturesT >
ShapePtrType AttachHeightmapShape ( const std::string _name,
const common::HeightmapData _heightmapData,
const PoseType _pose,
const Dimensions _size,
int  _subSampling = 1 
)

Attach a heightmap shape to a link.

Parameters
[in]_nameShape's name.
[in]_heightmapDataContains the 3D data for the heigthtmap.
[in]_posePosition in the world.
[in]_sizeHeightmap total size in meters.
[in]_subSamplingIncrease sampling to improve resolution.

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