Store state information of a physics::Collision object.
More...
#include <physics/phyiscs.hh>
Inherits State.
Store state information of a physics::Collision object.
This class captures the entire state of a Collision at one specific time during a simulation run.
State of a Collision is its Pose.
Constructor.
Build a CollisionState from an existing Collision.
- Parameters
-
[in] | _model | Pointer to the Link from which to gather state info. |
Constructor.
Build a CollisionState from SDF data
- Parameters
-
[in] | _sdf | SDF data to load a collision state from. |
void FillSDF |
( |
sdf::ElementPtr |
_sdf | ) |
|
Populate a state SDF element with data from the object.
- Parameters
-
[out] | _sdf | SDF element to populate. |
uint64_t GetIterations |
( |
| ) |
const |
|
inherited |
Get the iterations when this state was generated.
- Returns
- Iterations when the data was recorded
std::string GetName |
( |
| ) |
const |
|
inherited |
Get the name associated with this State.
- Returns
- Name associated with this state information. Typically a name of an Entity.
Get the real time when this state was generated.
- Returns
- Clock time since simulation was stated.
Get the sim time when this state was generated.
- Returns
- Simulation time when the data was recorded.
Get the wall time when this state was generated.
- Returns
- The absolute clock time when the State data was recorded.
Return true if the values in the state are zero.
- Returns
- True if the values in the state are zero.
virtual void Load |
( |
const sdf::ElementPtr |
_elem | ) |
|
|
virtual |
Load state from SDF element.
Load CollisionState information from stored data in and SDF::Element
- Parameters
-
[in] | _elem | Pointer to the SDF::Element containing state info. |
Reimplemented from State.
Addition operator.
- Parameters
-
- Returns
- The resulting state.
Subtraction operator.
- Parameters
-
[in] | _pt | A state to substract. |
- Returns
- The resulting state.
Subtraction operator.
- Parameters
-
[in] | _pt | A state to substract. |
- Returns
- The resulting state.
Assignment operator.
- Parameters
-
- Returns
- Reference to this
const ignition::math::Pose3d& Pose |
( |
| ) |
const |
virtual void SetIterations |
( |
const uint64_t |
_iterations | ) |
|
|
virtualinherited |
Set the iterations when this state was generated.
- Parameters
-
[in] | _iterations | Iterations when the data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
void SetName |
( |
const std::string & |
_name | ) |
|
|
inherited |
Set the name associated with this State.
- Parameters
-
[in] | _name | Name associated with this state information. Typically the name of an Entity. |
Set the real time when this state was generated.
- Parameters
-
[in] | _time | Clock time since simulation was stated. |
Reimplemented in ModelState, WorldState, and LinkState.
Set the sim time when this state was generated.
- Parameters
-
[in] | _time | Simulation time when the data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
Set the wall time when this state was generated.
- Parameters
-
[in] | _time | The absolute clock time when the State data was recorded. |
Reimplemented in ModelState, WorldState, and LinkState.
Stream insertion operator.
- Parameters
-
[in] | _out | output stream |
[in] | _state | Collision state to output |
- Returns
- the stream
The number of simulation iterations when this state was generated.
Name associated with this State.
Times for the state data.
The documentation for this class was generated from the following file: