Class Agent Extends IAgent

Private

Public Methods

ForceSetVelocity (velocity)

Set the current velocity of the agent.

Public

void ForceSetVelocity (

Vector3

velocity

)

Set the current velocity of the agent.

This will override the local avoidance input completely. It is useful if you have a player controlled character and want other agents to avoid it.

Calling this method will mark the agent as being externally controlled for 1 simulation step. Local avoidance calculations will be skipped for the next simulation step but will be resumed after that unless this method is called again.

SetCollisionNormal (normal)

Set the normal of a wall (or something else) the agent is currently colliding with.

Public

void SetCollisionNormal (

Vector3

normal

)

Set the normal of a wall (or something else) the agent is currently colliding with.

This is used to make the RVO system aware of things like physics or an agent being clamped to the navmesh. The velocity of this agent that other agents observe will be modified so that there is no component into the wall. The agent will however not start to avoid the wall, for that you will need to add RVO obstacles.

This value will be cleared after the next simulation step, normally it should be set every frame when the collision is still happening.

SetTarget (targetPoint, desiredSpeed, maxSpeed)

Point towards which the agent should move.

Public

void SetTarget (

Vector3

targetPoint

Target point in world space.

float

desiredSpeed

Desired speed of the agent. In world units per second. The agent will try to move with this speed if possible.

float

maxSpeed

Max speed of the agent. In world units per second. If necessary (for example if another agent is on a collision trajectory towards this agent) the agent can move at this speed. Should be at least as high as desiredSpeed, but it is recommended to use a slightly higher value than desiredSpeed (for example desiredSpeed*1.2).

)

Point towards which the agent should move.

Usually you set this once per frame. The agent will try move as close to the target point as possible. Will take effect at the next simulation step.

Note

The system assumes that the agent will stop when it reaches the target point so if you just want to move the agent in a particular direction, make sure that you set the target point a good distance in front of the character as otherwise the system may not avoid colisions that well. What would happen is that the system (in simplified terms) would think that the agents would stop before the collision and thus it wouldn't slow down or change course. See the image below. In the image the desiredSpeed is the length of the blue arrow and the target point is the point where the black arrows point to. In the upper case the agent does not avoid the red agent (you can assume that the red agent has a very small velocity for simplicity) while in the lower case it does.
If you are following a path a good way to pick the target point is to set it to targetPoint = directionToNextWaypoint.normalized * remainingPathDistance Where remainingPathDistance is the distance until the character would reach the end of the path. This works well because at the end of the path the direction to the next waypoint will just be the direction to the last point on the path and remainingPathDistance will be the distance to the last point in the path, so targetPoint will be set to simply the last point in the path. However when remainingPathDistance is large the target point will be so far away that the agent will essentially be told to move in a particular direction, which is precisely what we want.

Public Variables

AgentIndex

Public

int AgentIndex

AgentTimeHorizon

Public

float AgentTimeHorizon

CalculatedSpeed

Public

float CalculatedSpeed

CalculatedTargetPoint

Public

Vector3 CalculatedTargetPoint

CollidesWith

Public

RVOLayer CollidesWith

DebugDraw

Public

bool DebugDraw

FlowFollowingStrength

Public

float FlowFollowingStrength

Height

Public

float Height

Layer

Public

RVOLayer Layer

Locked

Public

bool Locked

MaxNeighbours

Public

int MaxNeighbours

MovementPlane

Public

SimpleMovementPlane MovementPlane

NeighbourCount

Public

int NeighbourCount

NeighbourObstacles

Public

List<ObstacleVertex> NeighbourObstacles

ObstacleTimeHorizon

Public

float ObstacleTimeHorizon

Position

Public

Vector3 Position

PreCalculationCallback

Public

Action PreCalculationCallback

Priority

Public

float Priority

Radius

Public

float Radius

agentIndex

Public

int agentIndex

simulator

Public

Vector3	targetPoint	Target point in world space.
float	desiredSpeed	Desired speed of the agent. In world units per second. The agent will try to move with this speed if possible.
float	maxSpeed	Max speed of the agent. In world units per second. If necessary (for example if another agent is on a collision trajectory towards this agent) the agent can move at this speed. Should be at least as high as desiredSpeed, but it is recommended to use a slightly higher value than desiredSpeed (for example desiredSpeed*1.2).

Class Agent Extends IAgent

Public Methods

void ForceSetVelocity ( Vector3 velocity )

void SetCollisionNormal ( Vector3 normal )

Note

Public Variables

int AgentIndex

float AgentTimeHorizon

float CalculatedSpeed

Vector3 CalculatedTargetPoint

RVOLayer CollidesWith

bool DebugDraw

float FlowFollowingStrength

float Height

RVOLayer Layer

bool Locked

int MaxNeighbours

SimpleMovementPlane MovementPlane

int NeighbourCount

List<ObstacleVertex> NeighbourObstacles

float ObstacleTimeHorizon

Vector3 Position

Action PreCalculationCallback

float Priority

float Radius

int agentIndex

SimulatorBurst simulator

void ForceSetVelocity (

Vector3

velocity

)

void SetCollisionNormal (

Vector3

normal

)