#include <Visual.hh>
Public Member Functions | |
Visual () | |
Default constructor. More... | |
Visual (const Visual &_visual) | |
Copy constructor. More... | |
Visual (Visual &&_visual) noexcept | |
Move constructor. More... | |
~Visual () | |
Destructor. More... | |
bool | CastShadows () const |
Get whether the visual casts shadows. 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 visual's geometry. More... | |
bool | HasLaserRetro () const |
Get whether the lidar reflective intensity was set was set. More... | |
double | LaserRetro () const |
Get the flidar reflective intensity. More... | |
Errors | Load (ElementPtr _sdf) |
Load the visual based on a element pointer. More... | |
sdf::Material * | Material () const |
Get a pointer to the visual's material properties. More... | |
std::string | Name () const |
Get the name of the visual. More... | |
Visual & | operator= (const Visual &_visual) |
Copy assignment operator. More... | |
Visual & | operator= (Visual &&_visual) |
Move assignment operator. More... | |
const gz::math::Pose3d & | Pose () const SDF_DEPRECATED(9.0) |
Get the pose of the visual object. More... | |
const std::string & | PoseFrame () const SDF_DEPRECATED(9.0) |
Get the name of the coordinate frame in which this visual 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 visual object. More... | |
sdf::SemanticPose | SemanticPose () const |
Get SemanticPose object of this object to aid in resolving poses. More... | |
void | SetCastShadows (bool _castShadows) |
Set whether the visual casts shadows. More... | |
void | SetGeom (const Geometry &_geom) |
Set the visual's geometry. More... | |
void | SetHasLaserRetro (bool _laserRetro) |
Set whether the lidar reflective intensity has been specified. More... | |
void | SetLaserRetro (double _laserRetro) |
Set the lidar reflective intensity. More... | |
void | SetMaterial (const sdf::Material &_material) |
Set the visual's material. More... | |
void | SetName (const std::string &_name) const |
Set the name of the visual. More... | |
void | SetPose (const gz::math::Pose3d &_pose) SDF_DEPRECATED(9.0) |
Set the pose of the visual object. More... | |
void | SetPoseFrame (const std::string &_frame) SDF_DEPRECATED(9.0) |
Set the name of the coordinate frame in which this visual 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 visual object. More... | |
void | SetTransparency (float _transparency) |
Set the transparency value for the visual. More... | |
void | SetVisibilityFlags (uint32_t _flags) |
Set the visibility flags of a visual. More... | |
float | Transparency () const |
Get the transparency value of the visual. More... | |
uint32_t | VisibilityFlags () const |
Get the visibility flags of a visual. More... | |
sdf::v9::Visual::Visual | ( | ) |
Default constructor.
sdf::v9::Visual::Visual | ( | const Visual & | _visual | ) |
Copy constructor.
[in] | _visual | Visual to copy. |
|
noexcept |
Move constructor.
[in] | _visual | Visual to move. |
sdf::v9::Visual::~Visual | ( | ) |
Destructor.
bool sdf::v9::Visual::CastShadows | ( | ) | const |
Get whether the visual casts shadows.
sdf::ElementPtr sdf::v9::Visual::Element | ( | ) | const |
const Geometry* sdf::v9::Visual::Geom | ( | ) | const |
Get a pointer to the visual's geometry.
bool sdf::v9::Visual::HasLaserRetro | ( | ) | const |
Get whether the lidar reflective intensity was set was set.
double sdf::v9::Visual::LaserRetro | ( | ) | const |
Get the flidar reflective intensity.
Errors sdf::v9::Visual::Load | ( | ElementPtr | _sdf | ) |
sdf::Material* sdf::v9::Visual::Material | ( | ) | const |
Get a pointer to the visual's material properties.
This can be a nullptr if material properties have not been set.
std::string sdf::v9::Visual::Name | ( | ) | const |
Get the name of the visual.
The name of the visual must be unique within the scope of a Link.
const gz::math::Pose3d& sdf::v9::Visual::Pose | ( | ) | const |
Get the pose of the visual object.
This is the pose of the visual as specified in SDF (<visual><pose> ... </pose></visual>).
const std::string& sdf::v9::Visual::PoseFrame | ( | ) | const |
Get the name of the coordinate frame in which this visual object's pose is expressed.
A empty value indicates that the frame is the parent link.
const std::string& sdf::v9::Visual::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::Visual::RawPose | ( | ) | const |
Get the pose of the visual object.
This is the pose of the visual as specified in SDF (<visual><pose> ... </pose></visual>).
sdf::SemanticPose sdf::v9::Visual::SemanticPose | ( | ) | const |
Get SemanticPose object of this object to aid in resolving poses.
void sdf::v9::Visual::SetCastShadows | ( | bool | _castShadows | ) |
Set whether the visual casts shadows.
[in] | _castShadows | True to cast shadows, false to not cast shadows |
void sdf::v9::Visual::SetGeom | ( | const Geometry & | _geom | ) |
Set the visual's geometry.
[in] | _geom | The geometry of the visual object |
void sdf::v9::Visual::SetHasLaserRetro | ( | bool | _laserRetro | ) |
Set whether the lidar reflective intensity has been specified.
[in] | _laserRetro | True if the lidar reflective intensity has been set in the sdf. |
void sdf::v9::Visual::SetLaserRetro | ( | double | _laserRetro | ) |
Set the lidar reflective intensity.
[in] | _laserRetro | The lidar reflective intensity. |
void sdf::v9::Visual::SetMaterial | ( | const sdf::Material & | _material | ) |
Set the visual's material.
[in] | _material | The material of the visual object |
void sdf::v9::Visual::SetName | ( | const std::string & | _name | ) | const |
Set the name of the visual.
The name of the visual must be unique within the scope of a Link.
[in] | _name | Name of the visual. |
void sdf::v9::Visual::SetPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the visual object.
[in] | _pose | The pose of the visual object. |
void sdf::v9::Visual::SetPoseFrame | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame in which this visual object's pose is expressed.
A empty value indicates that the frame is the parent link.
void sdf::v9::Visual::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::Visual::SetRawPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the visual object.
[in] | _pose | The pose of the visual object. |
void sdf::v9::Visual::SetTransparency | ( | float | _transparency | ) |
Set the transparency value for the visual.
[in] | _transparency | Transparency value between 0 and 1 |
void sdf::v9::Visual::SetVisibilityFlags | ( | uint32_t | _flags | ) |
Set the visibility flags of a visual.
[in] | _flags | visibility flags |
float sdf::v9::Visual::Transparency | ( | ) | const |
Get the transparency value of the visual.
uint32_t sdf::v9::Visual::VisibilityFlags | ( | ) | const |
Get the visibility flags of a visual.