Class SimulatorBurst

IAgent AddAgent (

Vector3

position

See IAgent.Position

)

Add an agent at the specified position.

You can use the returned interface to read and write parameters and set for example radius and desired point to move to.

AgentIndex AddAgentBurst (

float3

position

)

Add an agent at the specified position.

You can use the returned index to read and write parameters and set for example radius and desired point to move to.

bool AgentExists (

AgentIndex

agent

)

void BlockUntilSimulationStepDone ()

void ClearAgents ()

Removes all agents from the simulation.

void LockSimulationDataReadOnly (

JobHandle

dependencies

)

void OnDestroy ()

Frees all used memory.

void RemoveAgent (

IAgent

agent

)

Removes a specified agent from this simulation.

The agent can be added again later by using AddAgent.

void RemoveAgent (

AgentIndex

agent

)

SimulatorBurst (

MovementPlane

movementPlane

The plane that the movement happens in. XZ for 3D games, XY for 2D games.

)

Create a new simulator.

JobHandle Update (

JobHandle	dependency	Jobs that need to complete before local avoidance runs.
float	dt	Length of timestep in seconds.
bool	drawGizmos	If true, debug gizmos will be allowed to render (they never render in standalone games, though).
Allocator	allocator	Allocator to use for some temporary allocations. Should be a rewindable allocator since no disposal will be done.

)

Should be called once per frame.

Rect AgentBounds

int AgentCount

Number of agents in the simulation.

float DesiredDeltaTime

Time in seconds between each simulation step.

This is the desired delta time, the simulation will never run at a higher fps than the rate at which the Update function is called.

bool HardCollisions

Use hard collisions.

MovementPlane MovementPlane

float SymmetryBreakingBias

Bias agents to pass each other on the right side.

If the desired velocity of an agent puts it on a collision course with another agent or an obstacle its desired velocity will be rotated this number of radians (1 radian is approximately 57°) to the right. This helps to break up symmetries and makes it possible to resolve some situations much faster.

When many agents have the same goal this can however have the side effect that the group clustered around the target point may as a whole start to spin around the target point.

Recommended values are in the range of 0 to 0.2.

If this value is negative, the agents will be biased towards passing each other on the left side instead.

bool UseNavmeshAsObstacle

bool drawQuadtree

JobHandle lastJob

Job handle for the last update.

MovementPlane movementPlane = MovementPlane.XZ

Determines if the XY (2D) or XZ (3D) plane is used for movement.

ObstacleData obstacleData

Internal obstacle data.

Normally you will never need to access this directly

AgentOutputData outputData

Internal simulation data.

Can be used if you need very high performance access to the agent data. Normally you would use the SimulatorBurst.Agent class instead (implements the IAgent interface).

RVOQuadtreeBurst quadtree

Quadtree for this simulation.

Used internally by the simulation to perform fast neighbour lookups for each agent. Please only read from this tree, do not rebuild it since that can interfere with the simulation. It is rebuilt when necessary.

AgentData simulationData

Internal simulation data.

Can be used if you need very high performance access to the agent data. Normally you would use the SimulatorBurst.Agent class instead (implements the IAgent interface).

const int MaxBlockingAgentCount = 7

const int MaxNeighbourCount = 50

const int MaxObstacleVertices = 256

void AllocateAgentSpace ()

void PreCalculation (

JobHandle

dependency

)

JobHandle UpdateInternal<T> (

JobHandle	dependency
float	deltaTime
bool	drawGizmos
Allocator	allocator

)

Action[] agentDestroyCallbacks = new Action[0]

Action[] agentPreCalculationCallbacks = new Action[0]

Drawing.RedrawScope debugDrawingScope

Scope for drawing gizmos even on frames during which the simulation is not running.

This is used to draw the obstacles, quadtree and agent debug lines.

float desiredDeltaTime = 0.05f

Inverse desired simulation fps.

Stack<int> freeAgentIndices = new Stack<int>()

HorizonAgentData horizonAgentData

int numAgents = 0

Number of agents in this simulation.

TemporaryAgentData temporaryAgentData

IAgent AddAgent (

Vector2	position
float	elevationCoordinate

)

Add an agent at the specified position.

You can use the returned interface to read and write parameters and set for example radius and desired point to move to.

IAgent AddAgent (

IAgent

agent

)