com.badlogic.gdx.ai.steer.proximities

Class FieldOfViewProximity<T extends com.badlogic.gdx.math.Vector<T>>

java.lang.Object

com.badlogic.gdx.ai.steer.proximities.ProximityBase<T>

com.badlogic.gdx.ai.steer.proximities.FieldOfViewProximity<T>

Type Parameters:

T - Type of vector, either 2D or 3D, implementing the Vector interface

All Implemented Interfaces:

Proximity<T>

public class FieldOfViewProximity<T extends com.badlogic.gdx.math.Vector<T>>
extends ProximityBase<T>

FieldOfViewProximity emulates the peripheral vision of the owner as if it had eyes. Any agents contained in the specified list that are within the field of view of the owner are considered owner's neighbors. The field of view is determined by a radius and an angle in degrees.

Note that this implementation checks the AI time of the current frame through the GdxAI.getTimepiece().getTime() method in order to calculate neighbors only once per frame (assuming delta time is always greater than 0, if time has changed the frame has changed too). This means that

• if you forget to update the timepiece on each frame the proximity instance will be calculated only the very first time, which is not what you want of course.
• ideally the timepiece should be updated before the proximity is updated by the Proximity.findNeighbors(ProximityCallback) method.

Nested Class Summary

Nested classes/interfaces inherited from interface com.badlogic.gdx.ai.steer.Proximity

Proximity.ProximityCallback<T extends com.badlogic.gdx.math.Vector<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected float	angle The angle in radians of this proximity.
protected float	radius The radius of this proximity.

Fields inherited from class com.badlogic.gdx.ai.steer.proximities.ProximityBase

agents, owner

Constructor Summary

Constructors

Constructor and Description
FieldOfViewProximity(Steerable<T> owner, java.lang.Iterable<? extends Steerable<T>> agents, float radius, float angle) Creates a FieldOfViewProximity for the specified owner, agents and cone area defined by the given radius and angle in radians.

Method Summary

Modifier and Type	Method and Description
int	findNeighbors(Proximity.ProximityCallback<T> callback) Finds the agents that are within the immediate area of the owner.
float	getAngle() Returns the angle of this proximity in radians.
float	getRadius() Returns the radius of this proximity.
void	setAngle(float angle) Sets the angle of this proximity in radians.
void	setRadius(float radius) Sets the radius of this proximity.

Methods inherited from class com.badlogic.gdx.ai.steer.proximities.ProximityBase

getAgents, getOwner, setAgents, setOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

radius

protected float radius

The radius of this proximity.

angle

protected float angle

The angle in radians of this proximity.

Constructor Detail

FieldOfViewProximity

public FieldOfViewProximity(Steerable<T> owner,
                            java.lang.Iterable<? extends Steerable<T>> agents,
                            float radius,
                            float angle)

Creates a FieldOfViewProximity for the specified owner, agents and cone area defined by the given radius and angle in radians.

Parameters:

owner - the owner of this proximity

agents - the agents

radius - the radius of the cone area

angle - the angle in radians of the cone area

Method Detail

getRadius

public float getRadius()

Returns the radius of this proximity.

setRadius

public void setRadius(float radius)

Sets the radius of this proximity.

getAngle

public float getAngle()

Returns the angle of this proximity in radians.

setAngle

public void setAngle(float angle)

Sets the angle of this proximity in radians.

findNeighbors

public int findNeighbors(Proximity.ProximityCallback<T> callback)

Description copied from interface: Proximity

Finds the agents that are within the immediate area of the owner. Each of those agents is passed to the reportNeighbor method of the specified callback.

Returns:

the number of neighbors found.