INavigation Interface Reference

INavigation interface for robot navigation algorithms. This component of the robot is responsible for calculating a direction along a path to a specified location. More...

Public Member Functions
IEnumerator	SearchForPath ()
	Start the search algorithm to find a path from origin to destination. More...
IEnumerator	SearchForPath (Vector3 start, Vector3 end)
	Start the search algorithm to find a path from start to end. More...
Vector3	PathDirection (Vector3 myLocation)
	Gives a direction to follow the path given your location. More...
void	Proximity (Vector3 from, Vector3 to, bool obstructed)
	Proximity sensor data. More...
void	DrawGizmos ()
	Called by Unity OnDrawGizmos() event to draw 3D world space debug information. More...
void	DrawDebugInfo ()

Properties
Bounds	searchBounds [get, set]
	Gets or sets the search space bounds. More...
Vector3	origin [get, set]
	Gets or sets the origin. More...
Vector3	destination [get, set]
	Gets or sets the destination. More...
bool	pathFound [get]
	Gets a value indicating whether this INavigation found a path between origin and destination. More...
Space	spaceRelativeTo [get]
	Indicates the frame of reference World space is data relative to (0,0,0) Self space is data relative to robot position and rotation More...

Detailed Description

INavigation interface for robot navigation algorithms. This component of the robot is responsible for calculating a direction along a path to a specified location.

Definition at line 9 of file INavigation.cs.

Member Function Documentation

void INavigation.DrawDebugInfo

(

)

Here is the caller graph for this function:

void INavigation.DrawGizmos

(

)

Called by Unity OnDrawGizmos() event to draw 3D world space debug information.

Here is the caller graph for this function:

Vector3 INavigation.PathDirection

(

Vector3

myLocation

)

Gives a direction to follow the path given your location.

Returns

The path direction.

Parameters

myLocation

My location.

Here is the caller graph for this function:

void INavigation.Proximity	(	Vector3	from,
		Vector3	to,
		bool	obstructed
	)

Proximity sensor data.

Parameters

from	Sensor position.
to	Sensor reading position.
obstructed	If set to true position at to is obstructed.

Here is the caller graph for this function:

IEnumerator INavigation.SearchForPath

(

)

Start the search algorithm to find a path from origin to destination.

Returns

An iterator which enables Unity to continue execution after calling this routine.

Here is the caller graph for this function:

IEnumerator INavigation.SearchForPath	(	Vector3	start,
		Vector3	end
	)

Start the search algorithm to find a path from start to end.

Returns

An iterator which enables Unity to continue execution after calling this routine.

Property Documentation

Vector3 INavigation.destination

getset

Gets or sets the destination.

The destination is where the path leads to.

Definition at line 29 of file INavigation.cs.

Vector3 INavigation.origin

getset

Gets or sets the origin.

The origin is the start of the path to the destination.

Definition at line 23 of file INavigation.cs.

bool INavigation.pathFound

get

Gets a value indicating whether this INavigation found a path between origin and destination.

true if path found; otherwise, false.

Definition at line 49 of file INavigation.cs.

Bounds INavigation.searchBounds

getset

Gets or sets the search space bounds.

Defines the search space boundaries in simulation world coordinates.

Definition at line 17 of file INavigation.cs.

Space INavigation.spaceRelativeTo

get

Indicates the frame of reference World space is data relative to (0,0,0) Self space is data relative to robot position and rotation

Definition at line 73 of file INavigation.cs.

---

The documentation for this interface was generated from the following file:

• Assets/botnavsim/Scripts/INavigation/INavigation.cs