YARP
Yet Another Robot Platform
yarp::dev::Nav2D::MapGrid2DInfo Class Reference

#include <yarp/dev/MapGrid2DInfo.h>

+ Inheritance diagram for yarp::dev::Nav2D::MapGrid2DInfo:

Public Member Functions

 MapGrid2DInfo ()
 
XYWorld cell2World (XYCell cell) const
 
yarp::dev::Nav2D::Map2DLocation toLocation (XYCell cell) const
 
XYCell toXYCell (yarp::dev::Nav2D::Map2DLocation loc) const
 
XYCell world2Cell (XYWorld world) const
 
XYCell world2Cell_unsafeFast (XYWorld world) const
 
yarp::dev::Nav2D::Map2DLocation toLocation (XYWorld cell) const
 
XYWorld toXYWorld (yarp::dev::Nav2D::Map2DLocation loc) const
 
bool isInsideMap (XYCell cell) const
 Checks if a cell is inside the map. More...
 
bool isInsideMap (XYWorld world) const
 Checks if a world coordinate is inside the map. More...
 

Public Attributes

std::string m_map_name
 
double m_resolution
 meters/pixel More...
 
MapGrid2DOrigin m_origin
 pose of the map frame w.r.t. the bottom left corner of the map image More...
 
size_t m_width
 cells More...
 
size_t m_height
 cells More...
 

Detailed Description

Definition at line 53 of file MapGrid2DInfo.h.

Constructor & Destructor Documentation

◆ MapGrid2DInfo()

MapGrid2DInfo::MapGrid2DInfo ( )

Definition at line 56 of file MapGrid2DInfo.cpp.

Member Function Documentation

◆ cell2World()

XYWorld MapGrid2DInfo::cell2World ( XYCell  cell) const

Definition at line 65 of file MapGrid2DInfo.cpp.

◆ isInsideMap() [1/2]

bool MapGrid2DInfo::isInsideMap ( XYCell  cell) const

Checks if a cell is inside the map.

Parameters
cellis the cell location, referred to the top - left corner of the map.
Returns
true if cell is inside the map, false otherwise.

Definition at line 119 of file MapGrid2DInfo.cpp.

◆ isInsideMap() [2/2]

bool MapGrid2DInfo::isInsideMap ( XYWorld  world) const

Checks if a world coordinate is inside the map.

Parameters
worldis the world coordinate, expressed in meters, referred to the map origin reference frame.
Returns
true if cell is inside the map, false otherwise.

Definition at line 113 of file MapGrid2DInfo.cpp.

◆ toLocation() [1/2]

Map2DLocation MapGrid2DInfo::toLocation ( XYCell  cell) const

Definition at line 130 of file MapGrid2DInfo.cpp.

◆ toLocation() [2/2]

Map2DLocation MapGrid2DInfo::toLocation ( XYWorld  cell) const

Definition at line 136 of file MapGrid2DInfo.cpp.

◆ toXYCell()

XYCell MapGrid2DInfo::toXYCell ( yarp::dev::Nav2D::Map2DLocation  loc) const

Definition at line 141 of file MapGrid2DInfo.cpp.

◆ toXYWorld()

XYWorld MapGrid2DInfo::toXYWorld ( yarp::dev::Nav2D::Map2DLocation  loc) const

Definition at line 148 of file MapGrid2DInfo.cpp.

◆ world2Cell()

XYCell MapGrid2DInfo::world2Cell ( XYWorld  world) const

Definition at line 83 of file MapGrid2DInfo.cpp.

◆ world2Cell_unsafeFast()

XYCell MapGrid2DInfo::world2Cell_unsafeFast ( XYWorld  world) const

Definition at line 100 of file MapGrid2DInfo.cpp.

Member Data Documentation

◆ m_height

size_t yarp::dev::Nav2D::MapGrid2DInfo::m_height

cells

Definition at line 62 of file MapGrid2DInfo.h.

◆ m_map_name

std::string yarp::dev::Nav2D::MapGrid2DInfo::m_map_name

Definition at line 58 of file MapGrid2DInfo.h.

◆ m_origin

MapGrid2DOrigin yarp::dev::Nav2D::MapGrid2DInfo::m_origin

pose of the map frame w.r.t. the bottom left corner of the map image

Definition at line 60 of file MapGrid2DInfo.h.

◆ m_resolution

double yarp::dev::Nav2D::MapGrid2DInfo::m_resolution

meters/pixel

Definition at line 59 of file MapGrid2DInfo.h.

◆ m_width

size_t yarp::dev::Nav2D::MapGrid2DInfo::m_width

cells

Definition at line 61 of file MapGrid2DInfo.h.


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