com.badlogic.gdx.ai.steer.behaviors

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

java.lang.Object

com.badlogic.gdx.ai.steer.SteeringBehavior<T>

com.badlogic.gdx.ai.steer.GroupBehavior<T>

com.badlogic.gdx.ai.steer.behaviors.Cohesion<T>

Type Parameters:

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

All Implemented Interfaces:

Proximity.ProximityCallback<T>

public class Cohesion<T extends com.badlogic.gdx.math.Vector<T>>
extends GroupBehavior<T>
implements Proximity.ProximityCallback<T>

Cohesion is a group behavior producing a linear acceleration that attempts to move the agent towards the center of mass of the agents in its immediate area defined by the given Proximity. The acceleration is calculated by first iterating through all the neighbors and averaging their position vectors. This gives us the center of mass of the neighbors, the place the agents wants to get to, so it seeks to that position.

A sheep running after its flock is demonstrating cohesive behavior. Use this behavior to keep a group of agents together.

Field Summary

Fields inherited from class com.badlogic.gdx.ai.steer.GroupBehavior

proximity

Fields inherited from class com.badlogic.gdx.ai.steer.SteeringBehavior

enabled, limiter, owner

Constructor Summary

Constructors

Constructor and Description
Cohesion(Steerable<T> owner, Proximity<T> proximity) Creates a Cohesion for the specified owner and proximity.

Method Summary

Modifier and Type	Method and Description
protected SteeringAcceleration<T>	calculateRealSteering(SteeringAcceleration<T> steering) Calculates the steering acceleration produced by this behavior and writes it to the given steering output.
boolean	reportNeighbor(Steerable<T> neighbor) The callback method used to report a neighbor.
Cohesion<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
Cohesion<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
Cohesion<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.

Methods inherited from class com.badlogic.gdx.ai.steer.GroupBehavior

getProximity, setProximity

Methods inherited from class com.badlogic.gdx.ai.steer.SteeringBehavior

calculateSteering, getActualLimiter, getLimiter, getOwner, isEnabled, newVector

Methods inherited from class java.lang.Object

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

Constructor Detail

Cohesion

public Cohesion(Steerable<T> owner,
                Proximity<T> proximity)

Creates a Cohesion for the specified owner and proximity.

Parameters:

owner - the owner of this behavior.

proximity - the proximity to detect the owner's neighbors

Method Detail

calculateRealSteering

protected SteeringAcceleration<T> calculateRealSteering(SteeringAcceleration<T> steering)

Description copied from class: SteeringBehavior

Calculates the steering acceleration produced by this behavior and writes it to the given steering output.

This method is called by SteeringBehavior.calculateSteering(SteeringAcceleration) when this steering behavior is enabled.

Specified by:

calculateRealSteering in class SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

reportNeighbor

public boolean reportNeighbor(Steerable<T> neighbor)

Description copied from interface: Proximity.ProximityCallback

The callback method used to report a neighbor.

Specified by:

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

Parameters:

neighbor - the reported neighbor.

Returns:

true if the given neighbor is valid; false otherwise.

setOwner

public Cohesion<T> setOwner(Steerable<T> owner)

Description copied from class: SteeringBehavior

Sets the owner of this steering behavior.

Overrides:

setOwner in class SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setEnabled

public Cohesion<T> setEnabled(boolean enabled)

Description copied from class: SteeringBehavior

Sets this steering behavior on/off.

Overrides:

setEnabled in class SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setLimiter

public Cohesion<T> setLimiter(Limiter limiter)

Sets the limiter of this steering behavior. The given limiter must at least take care of the maximum linear acceleration.

Overrides:

setLimiter in class SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.