Provides a description of an actor. More...
#include <Actor.hh>
Public Member Functions | |
Actor () | |
Default constructor. More... | |
Actor (Actor &&_actor) noexcept | |
Move constructor. More... | |
Actor (const Actor &_actor) | |
Copy constructor. More... | |
~Actor () | |
Destructor. More... | |
void | AddAnimation (const Animation &_anim) |
Add a new animation. More... | |
void | AddTrajectory (const Trajectory &_traj) |
Add a new trajectory. More... | |
const Animation * | AnimationByIndex (uint64_t _index) const |
Get an animation based on an index. More... | |
uint64_t | AnimationCount () const |
Get the number of animations. More... | |
bool | AnimationNameExists (const std::string &_name) const |
Get whether an animation name exists. More... | |
void | CopyFrom (const Actor &_actor) |
Copy dataPtr from an actor instance. More... | |
sdf::ElementPtr | Element () const |
Get a pointer to the SDF element that was used during load. More... | |
const std::string & | FilePath () const |
The path to the file where this element was loaded from. More... | |
const Joint * | JointByIndex (uint64_t _index) const |
Get a joint based on an index. More... | |
uint64_t | JointCount () const |
Get the number of joints. More... | |
bool | JointNameExists (const std::string &_name) const |
Get whether a joint name exists. More... | |
const Link * | LinkByIndex (uint64_t _index) const |
Get a link based on an index. More... | |
uint64_t | LinkCount () const |
Get the number of links. More... | |
bool | LinkNameExists (const std::string &_name) const |
Get whether a link name exists. More... | |
Errors | Load (ElementPtr _sdf) |
Load the actor based on a element pointer. More... | |
std::string & | Name () const |
Get the name of the actor. More... | |
Actor & | operator= (Actor &&_actor) |
Move assignment operator. More... | |
Actor & | operator= (const Actor &_actor) |
Assignment operator. More... | |
const gz::math::Pose3d & | Pose () const SDF_DEPRECATED(9.0) |
Get the pose of the actor. More... | |
const std::string & | PoseFrame () const SDF_DEPRECATED(9.0) |
Get the name of the coordinate frame in which this actor'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 actor. More... | |
bool | ScriptAutoStart () const |
Get whether the animation plays when simulation starts. More... | |
double | ScriptDelayStart () const |
Get the time (in seconds) of delay to start. More... | |
bool | ScriptLoop () const |
Get whether the animation plays in loop. More... | |
void | SetFilePath (const std::string &_filePath) |
Set the path to the file where this element was loaded from. More... | |
void | SetName (const std::string &_name) |
Set the name of the actor. More... | |
void | SetPose (const gz::math::Pose3d &_pose) SDF_DEPRECATED(9.0) |
Set the pose of the actor. More... | |
void | SetPoseFrame (const std::string &_frame) SDF_DEPRECATED(9.0) |
Set the name of the coordinate frame in which this actor'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 actor. More... | |
void | SetScriptAutoStart (bool _scriptAutoStart) |
Set whether the animation plays when simulation starts. More... | |
void | SetScriptDelayStart (double _scriptDelayStart) |
Set the delay time to start. More... | |
void | SetScriptLoop (bool _scriptLoop) |
Set whether the animation plays in loop. More... | |
void | SetSkinFilename (std::string _skinFilename) |
Set the skin filename. More... | |
void | SetSkinScale (double _skinScale) |
Set the skin scale. More... | |
const std::string & | SkinFilename () const |
Get the skin filename. More... | |
double | SkinScale () const |
Get the skin scale. More... | |
const Trajectory * | TrajectoryByIndex (uint64_t _index) const |
Get a trajectory based on an index. More... | |
uint64_t | TrajectoryCount () const |
Get the number of trajectories. More... | |
bool | TrajectoryIdExists (uint64_t _id) const |
Get whether a trajectory id exists. More... | |
Provides a description of an actor.
sdf::v9::Actor::Actor | ( | ) |
Default constructor.
|
noexcept |
Move constructor.
[in] | _actor | Actor to move. |
sdf::v9::Actor::~Actor | ( | ) |
Destructor.
void sdf::v9::Actor::AddAnimation | ( | const Animation & | _anim | ) |
Add a new animation.
[in] | _anim | Animation to be added. |
void sdf::v9::Actor::AddTrajectory | ( | const Trajectory & | _traj | ) |
Add a new trajectory.
[in] | _traj | Trajectory to be added. |
const Animation* sdf::v9::Actor::AnimationByIndex | ( | uint64_t | _index | ) | const |
Get an animation based on an index.
[in] | _index | Index of the animation. The index should be in the range [0..AnimationCount()). |
uint64_t sdf::v9::Actor::AnimationCount | ( | ) | const |
Get the number of animations.
bool sdf::v9::Actor::AnimationNameExists | ( | const std::string & | _name | ) | const |
Get whether an animation name exists.
[in] | _name | Name of the animation to check. |
void sdf::v9::Actor::CopyFrom | ( | const Actor & | _actor | ) |
Copy dataPtr from an actor instance.
[in] | _actor | The actor to set values from. |
sdf::ElementPtr sdf::v9::Actor::Element | ( | ) | const |
const std::string& sdf::v9::Actor::FilePath | ( | ) | const |
The path to the file where this element was loaded from.
const Joint* sdf::v9::Actor::JointByIndex | ( | uint64_t | _index | ) | const |
Get a joint based on an index.
[in] | _index | Index of the joint. The index should be in the range [0..JointCount()). |
uint64_t sdf::v9::Actor::JointCount | ( | ) | const |
Get the number of joints.
bool sdf::v9::Actor::JointNameExists | ( | const std::string & | _name | ) | const |
Get whether a joint name exists.
[in] | _name | Name of the joint to check. |
const Link* sdf::v9::Actor::LinkByIndex | ( | uint64_t | _index | ) | const |
Get a link based on an index.
[in] | _index | Index of the link. The index should be in the range [0..LinkCount()). |
uint64_t sdf::v9::Actor::LinkCount | ( | ) | const |
Get the number of links.
bool sdf::v9::Actor::LinkNameExists | ( | const std::string & | _name | ) | const |
Get whether a link name exists.
[in] | _name | Name of the link to check. |
Errors sdf::v9::Actor::Load | ( | ElementPtr | _sdf | ) |
std::string& sdf::v9::Actor::Name | ( | ) | const |
Get the name of the actor.
Assignment operator.
[in] | _actor | The actor to set values from. |
const gz::math::Pose3d& sdf::v9::Actor::Pose | ( | ) | const |
Get the pose of the actor.
This is the pose of the actor as specified in SDF (<actor> <pose> ... </pose></actor>), and is typically used to express the position and rotation of an actor in a global coordinate frame.
const std::string& sdf::v9::Actor::PoseFrame | ( | ) | const |
Get the name of the coordinate frame in which this actor's pose is expressed.
A empty value indicates that the frame is the global/world coordinate frame.
const std::string& sdf::v9::Actor::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 world frame.
const gz::math::Pose3d& sdf::v9::Actor::RawPose | ( | ) | const |
Get the pose of the actor.
This is the pose of the actor as specified in SDF (<actor> <pose> ... </pose></actor>), and is typically used to express the position and rotation of an actor in a global coordinate frame.
bool sdf::v9::Actor::ScriptAutoStart | ( | ) | const |
Get whether the animation plays when simulation starts.
double sdf::v9::Actor::ScriptDelayStart | ( | ) | const |
Get the time (in seconds) of delay to start.
bool sdf::v9::Actor::ScriptLoop | ( | ) | const |
Get whether the animation plays in loop.
void sdf::v9::Actor::SetFilePath | ( | const std::string & | _filePath | ) |
Set the path to the file where this element was loaded from.
\paramp[in] _filePath Full path to the file on disk.
void sdf::v9::Actor::SetName | ( | const std::string & | _name | ) |
Set the name of the actor.
[in] | _name | Name of the actor. |
void sdf::v9::Actor::SetPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the actor.
[in] | _pose | The new actor pose. |
void sdf::v9::Actor::SetPoseFrame | ( | const std::string & | _frame | ) |
Set the name of the coordinate frame in which this actor's pose is expressed.
A empty value indicates that the frame is the global/world coordinate frame.
[in] | _frame | The name of the pose frame. |
void sdf::v9::Actor::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 world frame.
[in] | _frame | The name of the pose relative-to frame. |
void sdf::v9::Actor::SetRawPose | ( | const gz::math::Pose3d & | _pose | ) |
Set the pose of the actor.
[in] | _pose | The new actor pose. |
void sdf::v9::Actor::SetScriptAutoStart | ( | bool | _scriptAutoStart | ) |
Set whether the animation plays when simulation starts.
[in] | _staticAutoStart | True to indicate that the animation plays when simulation starts. |
void sdf::v9::Actor::SetScriptDelayStart | ( | double | _scriptDelayStart | ) |
Set the delay time to start.
[in] | _scriptDelayStart | Time of delay to start. |
void sdf::v9::Actor::SetScriptLoop | ( | bool | _scriptLoop | ) |
Set whether the animation plays in loop.
[in] | _scriptLoop | True to indicate that the animation plays in loop. |
void sdf::v9::Actor::SetSkinFilename | ( | std::string | _skinFilename | ) |
Set the skin filename.
[in] | _skinFilename | Skin filename. |
void sdf::v9::Actor::SetSkinScale | ( | double | _skinScale | ) |
Set the skin scale.
[in] | _skinScale | Skin scale. |
const std::string& sdf::v9::Actor::SkinFilename | ( | ) | const |
Get the skin filename.
double sdf::v9::Actor::SkinScale | ( | ) | const |
Get the skin scale.
const Trajectory* sdf::v9::Actor::TrajectoryByIndex | ( | uint64_t | _index | ) | const |
Get a trajectory based on an index.
[in] | _index | Index of the trajectory. The index should be in the range [0..TrajectoryCount()). |
uint64_t sdf::v9::Actor::TrajectoryCount | ( | ) | const |
Get the number of trajectories.
bool sdf::v9::Actor::TrajectoryIdExists | ( | uint64_t | _id | ) | const |
Get whether a trajectory id exists.
[in] | _id | Id of the trajectory to check. |