FrameSemantics::Frame< PolicyT, FeaturesT > Class Template Reference
Base class for the API of a Frame. This will be inherited by any objects that are able to express Frame Semantics. More...
#include <FrameSemantics.hh>
Public Types | |
| using | FrameData = ignition::physics::FrameData< typename PolicyT::Scalar, PolicyT::Dim > |
Public Member Functions | |
| 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... | |
Detailed Description
template<typename PolicyT, typename FeaturesT>
class ignition::physics::FrameSemantics::Frame< PolicyT, FeaturesT >
Base class for the API of a Frame. This will be inherited by any objects that are able to express Frame Semantics.
Member Typedef Documentation
◆ FrameData
| using FrameData = ignition::physics::FrameData<typename PolicyT::Scalar, PolicyT::Dim> |
Constructor & Destructor Documentation
◆ ~Frame()
|
virtualdefault |
Virtual destructor.
Member Function Documentation
◆ FrameDataRelativeTo() [1/2]
Get the FrameData of this object with respect to another frame. The data will also be expressed in the coordinates of the _relativeTo frame.
◆ FrameDataRelativeTo() [2/2]
| 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.
◆ FrameDataRelativeToWorld()
| FrameData FrameDataRelativeToWorld | ( | ) | const |
Get the FrameData of this object with respect to the world.
◆ GetFrameID()
◆ operator FrameID()
| operator FrameID | ( | ) | const |
The documentation for this class was generated from the following file: