A collision element descibes the collision properties associated with a link. More...
#include <Collision.hh>
Public Member Functions | |
Collision () | |
Default constructor. More... | |
Collision (Collision &&_collision) noexcept | |
Move constructor. More... | |
Collision (const Collision &_collision) | |
Copy constructor. More... | |
~Collision () | |
Destructor. More... | |
sdf::ElementPtr | Element () const |
Get a pointer to the SDF element that was used during load. More... | |
const Geometry * | Geom () const |
Get a pointer to the collisions's geometry. More... | |
Errors | Load (ElementPtr _sdf) |
Load the collision based on a element pointer. More... | |
std::string | Name () const |
Get the name of the collision. More... | |
Collision & | operator= (Collision &&_collision) |
Move assignment operator. More... | |
Collision & | operator= (const Collision &_collision) |
Copy assignment operator. More... | |
const gz::math::Pose3d & | Pose () const SDF_DEPRECATED(9.0) |
Get the pose of the collision object. More... | |
const std::string & | PoseFrame () const SDF_DEPRECATED(9.0) |
Get the name of the coordinate frame in which this collision object's pose is expressed. More... | |
const std::string & | PoseRelativeTo () const |
Get the name of the coordinate frame relative to which this object's pose is expressed. More... | |
const gz::math::Pose3d & | RawPose () const |
Get the pose of the collision object. More... | |
sdf::SemanticPose | SemanticPose () const |
Get SemanticPose object of this object to aid in resolving poses. More... | |
void | SetGeom (const Geometry &_geom) |
Set the collision's geometry. More... | |
void | SetName (const std::string &_name) const |
Set the name of the collision. More... | |
void | SetPose (const gz::math::Pose3d &_pose) SDF_DEPRECATED(9.0) |
Set the pose of the collision object. More... | |
void | SetPoseFrame (const std::string &_frame) SDF_DEPRECATED(9.0) |
Set the name of the coordinate frame in which this collision object's pose is expressed. More... | |
void | SetPoseRelativeTo (const std::string &_frame) |
Set the name of the coordinate frame relative to which this object's pose is expressed. More... | |
void | SetRawPose (const gz::math::Pose3d &_pose) |
Set the pose of the collision object. More... | |
void | SetSurface (const sdf::Surface &_surface) |
Set the collision's surface parameters. More... | |
sdf::Surface * | Surface () const |
Get a pointer to the collisions's surface parameters. More... | |
A collision element descibes the collision properties associated with a link.
This can be different from the visual properties of a link. For example, simple collision models are often used to reduce computation time.
sdf::v9::Collision::Collision | ( | ) |
Default constructor.
sdf::v9::Collision::Collision | ( | const Collision & | _collision | ) |
Copy constructor.
[in] | _collision | Collision to copy. |
|
noexcept |
Move constructor.
[in] | _collision | Collision to move. |
sdf::v9::Collision::~Collision | ( | ) |
Destructor.
sdf::ElementPtr sdf::v9::Collision::Element | ( | ) | const |
const Geometry* sdf::v9::Collision::Geom | ( | ) | const |
Get a pointer to the collisions's geometry.
Errors sdf::v9::Collision::Load | ( | ElementPtr | _sdf | ) |
std::string sdf::v9::Collision::Name | ( | ) | const |
Get the name of the collision.
The name of the collision must be unique within the scope of a Link.
const gz::math::Pose3d& sdf::v9::Collision::Pose | ( | ) | const |
Get the pose of the collision object.
This is the pose of the collision as specified in SDF (<collision><pose> ... </pose></collision>).
const std::string& sdf::v9::Collision::PoseFrame | ( | ) | const |
Get the name of the coordinate frame in which this collision object's pose is expressed.
A empty value indicates that the frame is the parent link.
const std::string& sdf::v9::Collision::PoseRelativeTo | ( | ) | const |
Get the name of the coordinate frame relative to which this object's pose is expressed.
An empty value indicates that the frame is relative to the parent link.
const gz::math::Pose3d& sdf::v9::Collision::RawPose | ( | ) | const |
Get the pose of the collision object.
This is the pose of the collison as specified in SDF (<collision><pose> ... </pose></collision>).
sdf::SemanticPose sdf::v9::Collision::SemanticPose | ( | ) | const |
Get SemanticPose object of this object to aid in resolving poses.
void sdf::v9::Collision::SetGeom | ( | const Geometry & | _geom | ) |
Set the collision's geometry.
[in] | _geom | The geometry of the collision object |
void sdf::v9::Collision::SetName | ( | const std::string & | _name | ) | const |
Set the name of the collision.
The name of the collision must be unique within the scope of a Link.
[in] | _name | Name of the collision. |
void sdf::v9::Collision::SetPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the collision object.
[in] | _pose | The pose of the collision object. |
void sdf::v9::Collision::SetPoseFrame | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame in which this collision object's pose is expressed.
A empty value indicates that the frame is the parent link.
[in] | _frame | The name of the pose frame. |
void sdf::v9::Collision::SetPoseRelativeTo | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame relative to which this object's pose is expressed.
An empty value indicates that the frame is relative to the parent link.
[in] | _frame | The name of the pose relative-to frame. |
void sdf::v9::Collision::SetRawPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the collision object.
[in] | _pose | The pose of the collision object. |
void sdf::v9::Collision::SetSurface | ( | const sdf::Surface & | _surface | ) |
Set the collision's surface parameters.
[in] | _surface | The surface parameters of the collision object |
sdf::Surface* sdf::v9::Collision::Surface | ( | ) | const |
Get a pointer to the collisions's surface parameters.