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 = FrameData< typename PolicyT::Scalar, PolicyT::Dim > |
 Public Types inherited from Entity< PolicyT, FeaturesT > | |
| using | Features = FeaturesT |
| using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
| using | Policy = PolicyT |
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... | |
| Public Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| virtual | ~Entity ()=default |
| Virtual destructor. More... | |
| std::size_t | EntityID () const |
| Get the unique ID value of this Entity. More... | |
| const std::shared_ptr< void > & | EntityReference () const |
| Get a reference-counting std::shared_ptr to the object inside the implementation that this object provides an abstraction for. More... | |
| const Identity & | FullIdentity () const |
| Get the Identity object of this Entity. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| Entity (const std::shared_ptr< Pimpl > &_pimpl=nullptr, const Identity &_identity=Identity()) | |
| Constructor for the Entity. More... | |
| Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity) | |
| Constructor that allows the pimpl to be moved instead of copied. More... | |
| template<typename FeatureT > | |
| FeatureT::template Implementation< PolicyT > * | Interface () |
| Get a pointer to the implementation of FeatureT. More... | |
| template<typename FeatureT > | |
| const FeatureT::template Implementation< PolicyT > * | Interface () const |
| Same as Interface(), but const-qualified so that const entities can request const-qualified interfaces from the implementation. More... | |
| Protected Attributes inherited from Entity< PolicyT, FeaturesT > | |
| Identity | identity |
| This field contains information to identify the entity. More... | |
| std::shared_ptr< Pimpl > | pimpl |
| This is a pointer to the physics engine implementation, and it can be used by the object features to find the interfaces that they need in order to function. More... | |
Detailed Description
template<typename PolicyT, typename FeaturesT>
class gz::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
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: