Gazebo Physics

API Reference

5.3.2
GetShapeBoundingBox::Shape< PolicyT, FeaturesT > Class Template Reference

#include <Shape.hh>

Public Types

using AlignedBoxType = typename FromPolicy< PolicyT >::template Use< AlignedBox >
 
- Public Types inherited from FrameSemantics::Frame< PolicyT, FeaturesT >
using FrameData = ignition::physics::FrameData< typename PolicyT::Scalar, PolicyT::Dim >
 

Public Member Functions

AlignedBoxType GetAxisAlignedBoundingBox (const FrameID &_referenceFrame=FrameID::World()) const
 Get the axis aligned bounding box for the shape in the requested frame. More...
 
- Public Member Functions inherited from FrameSemantics::Frame< PolicyT, FeaturesT >
virtual ~Frame ()=default
 Virtual destructor. More...
 
FrameData FrameDataRelativeTo (const FrameID &_relativeTo) const
 Get the FrameData of this object with respect to another frame. The data will also be expressed in the coordinates of the _relativeTo frame. More...
 
FrameData FrameDataRelativeTo (const FrameID &_relativeTo, const FrameID &_inCoordinatesOf) const
 Get the FrameData of this object relative to another frame, expressed in the coordinates of a third frame. More...
 
FrameData FrameDataRelativeToWorld () const
 Get the FrameData of this object with respect to the world. More...
 
FrameID GetFrameID () const
 Get a FrameID for this object. More...
 
 operator FrameID () const
 Implicit conversion to a FrameID is provided. This way, a reference to the Object can be treated as a FrameID. More...
 

Member Typedef Documentation

◆ AlignedBoxType

using AlignedBoxType = typename FromPolicy<PolicyT>::template Use<AlignedBox>

Member Function Documentation

◆ GetAxisAlignedBoundingBox()

AlignedBoxType GetAxisAlignedBoundingBox ( const FrameID _referenceFrame = FrameID::World()) const

Get the axis aligned bounding box for the shape in the requested frame.

Parameters
[in]_referenceFrameThe desired frame for the bounding box. By default, this will be the world frame.
Note
Axis-aligned bounding boxes will expand each time they are transformed into a new frame that has a different orientation.
Returns
Axis aligned bounding box for the shape, transformed into the requested coordinate frame.

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