com.badlogic.gdx.ai.steer.proximities

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

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

Proximity<T>

Direct Known Subclasses:

FieldOfViewProximity, InfiniteProximity, RadiusProximity

public abstract class ProximityBase<T extends com.badlogic.gdx.math.Vector<T>>
extends java.lang.Object
implements Proximity<T>

ProximityBase is the base class for any concrete proximity based on an iterable collection of agents.

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 java.lang.Iterable<? extends Steerable<T>>	agents The collection of the agents handled by this proximity.
protected Steerable<T>	owner The owner of this proximity.

Constructor Summary

Constructors

Constructor and Description
ProximityBase(Steerable<T> owner, java.lang.Iterable<? extends Steerable<T>> agents) Creates a ProximityBase for the specified owner and list of agents.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<? extends Steerable<T>>	getAgents() Returns the the agents that represent potential neighbors.
Steerable<T>	getOwner() Returns the owner of this proximity.
void	setAgents(java.lang.Iterable<Steerable<T>> agents) Sets the agents that represent potential neighbors.
void	setOwner(Steerable<T> owner) Sets the owner of this proximity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.badlogic.gdx.ai.steer.Proximity

findNeighbors

Field Detail

owner

protected Steerable<T extends com.badlogic.gdx.math.Vector<T>> owner

The owner of this proximity.

agents

protected java.lang.Iterable<? extends Steerable<T extends com.badlogic.gdx.math.Vector<T>>> agents

The collection of the agents handled by this proximity.

Note that, being this field of type Iterable, you can either use java or libgdx collections. See https://github.com/libgdx/gdx-ai/issues/65

Constructor Detail

ProximityBase

public ProximityBase(Steerable<T> owner,
                     java.lang.Iterable<? extends Steerable<T>> agents)

Creates a ProximityBase for the specified owner and list of agents.

Parameters:

owner - the owner of this proximity

agents - the list of agents

Method Detail

getOwner

public Steerable<T> getOwner()

Description copied from interface: Proximity

Returns the owner of this proximity.

Specified by:

getOwner in interface Proximity<T extends com.badlogic.gdx.math.Vector<T>>

setOwner

public void setOwner(Steerable<T> owner)

Description copied from interface: Proximity

Sets the owner of this proximity.

Specified by:

setOwner in interface Proximity<T extends com.badlogic.gdx.math.Vector<T>>

getAgents

public java.lang.Iterable<? extends Steerable<T>> getAgents()

Returns the the agents that represent potential neighbors.

setAgents

public void setAgents(java.lang.Iterable<Steerable<T>> agents)

Sets the agents that represent potential neighbors.