habitat_sim.nav.ShortestPath class

Struct for shortest path finding. Used in conjunction with PathFinder.findPath().

Special methods

def __format__(self, format_spec, /)
Default object formatter.
def __init__(self, /) -> None

Properties

geodesic_distance: float get set
The geodesic distance between requestedStart and requestedEnd. Will be inf if no path exists.
points: list[magnum.Vector3] get set
A list of points that specify the shortest path on the navigation mesh between requestedStart and requestedEnd. Will be empty if no path exists.
requested_end: magnum.Vector3 get set
The ending point for the path.
requested_start: magnum.Vector3 get set
The starting point for the path.

Method documentation

def habitat_sim.nav.ShortestPath.__format__(self, format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.