Placement surface configuration information. More...
#include <PlacementSurface.h>
Public Member Functions | |
| const std::string & | getFrameID () const |
| Frame ID value accessor. | |
| const std::string & | getNavFrameID () const |
| Navigation frame ID value accessor. | |
| PlacementSurface (const std::string &frame_id="", const std::string &nav_frame_id="") | |
| Create a new PlacementSurface. | |
| void | setFrameID (const std::string &frame_id) |
| Frame ID value mutator. | |
| void | setNavFrameID (const std::string &nav_frame_id) |
| Navigation frame ID value mutator. | |
Private Attributes | |
| std::string | frame_id_ |
| std::string | nav_frame_id_ |
Placement surface configuration information.
Surface configuration information.
A placement surface contains a frame ID and associated navigation frame ID.
A surface consists of a name and size with associated placement frames and points of interest.
Definition at line 27 of file PlacementSurface.h.
| PlacementSurface::PlacementSurface | ( | const std::string & | frame_id = "", |
| const std::string & | nav_frame_id = "" |
||
| ) |
Create a new PlacementSurface.
Create a new PlacementSurface with the given frame IDs.
| frame_id | The frame ID of the POI (defaults to the empty string). |
| nav_frame_id | The name of the navigation frame ID (defaults to the empty string). |
Definition at line 16 of file PlacementSurface.cpp.
| const string & PlacementSurface::getFrameID | ( | ) | const |
Frame ID value accessor.
Get the frame ID value of this PlacementSurface.
Definition at line 21 of file PlacementSurface.cpp.
| const string & PlacementSurface::getNavFrameID | ( | ) | const |
Navigation frame ID value accessor.
Get the navigation frame ID value of this PlacementSurface.
Definition at line 31 of file PlacementSurface.cpp.
| void PlacementSurface::setFrameID | ( | const std::string & | frame_id | ) |
Frame ID value mutator.
Set the frame ID value of this PlacementSurface.
| frame_id | The new frame ID name value. |
Definition at line 26 of file PlacementSurface.cpp.
| void PlacementSurface::setNavFrameID | ( | const std::string & | nav_frame_id | ) |
Navigation frame ID value mutator.
Set the navigation frame ID value of this PlacementSurface.
| frame_id | The new navigation frame ID value. |
Definition at line 36 of file PlacementSurface.cpp.
std::string rail::interactive_world::PlacementSurface::frame_id_ [private] |
Name of the frame ID and navigation frame ID.
Definition at line 78 of file PlacementSurface.h.
std::string rail::interactive_world::PlacementSurface::nav_frame_id_ [private] |
Definition at line 78 of file PlacementSurface.h.