Drake
GeometryFrame Class Reference

This simple class carries the definition of a frame used by GeometryWorld. More...

#include <drake/geometry/geometry_frame.h>

Public Member Functions

 GeometryFrame (const std::string &frame_name, const Isometry3< double > &X_PF, int frame_group_id=0)
 Constructor. More...
 
FrameId id () const
 Returns the globally unique id for this geometry specification. More...
 
const std::string & name () const
 
const Isometry3< double > & pose () const
 
int frame_group () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 GeometryFrame (const GeometryFrame &)=default
 
GeometryFrameoperator= (const GeometryFrame &)=default
 
 GeometryFrame (GeometryFrame &&)=default
 
GeometryFrameoperator= (GeometryFrame &&)=default
 

Detailed Description

This simple class carries the definition of a frame used by GeometryWorld.

To register moving frames with GeometryWorld (see GeometryWorld::RegisterFrame), a geometry source (see GeometryWorld::RegisterNewSource) instantiates a frame and passes ownership over to GeometryWorld.

A frame is defined by three pieces of information:

  • the name, which must be unique within a single geometry source,
  • the "frame group", an integer identifier that can be used to group frames together within a geometry source, and
  • the initial pose of the frame (measured and expressed in its parent frame). The parent is defined at registration. This is only the initial pose; registered frames are expected to move with time.

Constructor & Destructor Documentation

GeometryFrame ( const GeometryFrame )
default
GeometryFrame ( GeometryFrame &&  )
default
GeometryFrame ( const std::string &  frame_name,
const Isometry3< double > &  X_PF,
int  frame_group_id = 0 
)
inline

Constructor.

Parameters
frame_nameThe name of the frame.
X_PFThe initial pose of this frame F, measured and expressed in the intended parent frame P.
frame_group_idThe optional frame group identifier. If unspecified, defaults to the common, 0 group.

Member Function Documentation

int frame_group ( ) const
inline

Here is the caller graph for this function:

FrameId id ( ) const
inline

Returns the globally unique id for this geometry specification.

Every instantiation of FrameInstance will contain a unique id value. The id value is preserved across copies. After successfully registering this FrameInstance, this id will serve as the identifier for the registered representation as well.

Here is the caller graph for this function:

const std::string& name ( ) const
inline

Here is the caller graph for this function:

GeometryFrame& operator= ( GeometryFrame &&  )
default
GeometryFrame& operator= ( const GeometryFrame )
default
const Isometry3<double>& pose ( ) const
inline

Here is the caller graph for this function:


The documentation for this class was generated from the following file: