Class Graph::LiftProperties

Nested Relationships

This class is a nested type of Class Graph.

Class Documentation

class LiftProperties

Properties related to lifts (elevators) that exist in the graph.

Public Functions

const std::string &name() const

Get the name of the lift.

Eigen::Vector2d location() const

Get the (x, y) location of the lift in RMF canonical coordinates.

double orientation() const

Get the orientation (in radians) of the lift in RMF canonical coordinates.

Eigen::Vector2d dimensions() const

Get the dimensions of the lift, aligned with the lift’s local (x, y) coordinates.

bool is_in_lift(Eigen::Vector2d position, double envelope = 0.0) const

Get whether the specified position, given in RMF canonical coordinates, is inside the lift. The envelope will expand the footprint of the lift that is used in the calculation.

LiftProperties(std::string name, Eigen::Vector2d location, double orientations, Eigen::Vector2d dimensions)

Constructor.