matrx.agents.agent_utils.navigator.Navigator

class Navigator(agent_id, action_set, algorithm='a_star', is_circular=False)

A navigator object that can be used for path planning and navigation

Parameters
agent_id: string.

ID of the agent that wants to navigate

action_set: list

List of actions the agent can perform

algorithm: string. Optional, default “a_star”

The pathplanning algorithm to use. As of now only a_star is supported.

is_circular: Boolean. Optional, default=False.

Whether to continuously navigate from point A to B, and back, until infinity.

Methods

add_waypoint

add_waypoints

get_all_waypoints

get_current_waypoint

get_move_action

get_upcoming_waypoints

reset

reset_full

__init__(self, agent_id, action_set, algorithm='a_star', is_circular=False)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, agent_id, action_set[, …])

Initialize self.

add_waypoint(self, waypoint)

add_waypoints(self, waypoints[, is_circular])

get_all_waypoints(self)

get_current_waypoint(self)

get_move_action(self, state_tracker)

get_upcoming_waypoints(self)

reset(self)

reset_full(self)

Attributes

A_STAR_ALGORITHM