Infohazard.HyperNav.AvoidanceManager Class Reference

Handles calculating the avoidance velocities for all IAvoidanceAgents. More...

Public Member Functions
virtual void	UpdateAvoidance (float deltaTime)
	Update the avoidance of all agents. Can be called manually if UpdateMode is set to manual. More...

Protected Member Functions
virtual void	OnEnable ()
	Schedule coroutine when the manager is enabled. More...
void	OnDisable ()
	Dispose data structures when disabled. Coroutine will stop automatically. More...

Properties
AvoidanceManagerUpdateMode	UpdateMode [get, set]
	When to update the avoidance velocities of agents. More...
float	TimeHorizon [get, set]
	How far in the future to look when avoiding collisions. More...
int	MaxObstaclesConsidered [get, set]
	The maximum number of obstacles that can be considered by each agent for avoidance. More...

Detailed Description

Handles calculating the avoidance velocities for all IAvoidanceAgents.

There should only be one AvoidanceManager active at a time, as it will handle all agents together. This is done using the C# Job System and Burst compiler to calculate avoidance very quickly. If it is still not fast enough, try changing the TimeHorizon and/or MaxObstaclesConsidered values.

Member Function Documentation

OnDisable()

void Infohazard.HyperNav.AvoidanceManager.OnDisable ( )

protected

Dispose data structures when disabled. Coroutine will stop automatically.

OnEnable()

virtual void Infohazard.HyperNav.AvoidanceManager.OnEnable ( )

protectedvirtual

Schedule coroutine when the manager is enabled.

UpdateAvoidance()

virtual void Infohazard.HyperNav.AvoidanceManager.UpdateAvoidance ( float  deltaTime )

virtual

Update the avoidance of all agents. Can be called manually if UpdateMode is set to manual.

Parameters

deltaTime

Time delta since last call.

Property Documentation

MaxObstaclesConsidered

int Infohazard.HyperNav.AvoidanceManager.MaxObstaclesConsidered

getset

The maximum number of obstacles that can be considered by each agent for avoidance.

This value caps the number of avoidance calculations per agent. Generally it should be equal to the max number of obstacles you expect to be within TimeHorizon * IAvoidanceObstacle.MaxSpeed of an agent.

TimeHorizon

float Infohazard.HyperNav.AvoidanceManager.TimeHorizon

getset

How far in the future to look when avoiding collisions.

A lower value reduces the number of calculations per agent, with the drawback of being able to plan less far ahead.

UpdateMode

AvoidanceManagerUpdateMode Infohazard.HyperNav.AvoidanceManager.UpdateMode

getset

When to update the avoidance velocities of agents.

---

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

• Runtime/Avoidance/AvoidanceManager.cs