com.badlogic.gdx.ai.steer

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

java.lang.Object

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

Type Parameters:

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

Direct Known Subclasses:

Arrive, BlendedSteering, FollowFlowField, GroupBehavior, MatchVelocity, PrioritySteering, Pursue, RaycastObstacleAvoidance, ReachOrientation, Seek

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

A SteeringBehavior calculates the linear and/or angular accelerations to be applied to its owner.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled A flag indicating whether this steering behavior is enabled or not.
protected Limiter	limiter The limiter of this steering behavior
protected Steerable<T>	owner The owner of this steering behavior

Constructor Summary

Constructors

Constructor and Description
SteeringBehavior(Steerable<T> owner) Creates a SteeringBehavior for the specified owner.
SteeringBehavior(Steerable<T> owner, boolean enabled) Creates a SteeringBehavior for the specified owner and activation flag.
SteeringBehavior(Steerable<T> owner, Limiter limiter) Creates a SteeringBehavior for the specified owner and limiter.
SteeringBehavior(Steerable<T> owner, Limiter limiter, boolean enabled) Creates a SteeringBehavior for the specified owner, limiter and activation flag.

Method Summary

Modifier and Type	Method and Description
protected abstract SteeringAcceleration<T>	calculateRealSteering(SteeringAcceleration<T> steering) Calculates the steering acceleration produced by this behavior and writes it to the given steering output.
SteeringAcceleration<T>	calculateSteering(SteeringAcceleration<T> steering) If this behavior is enabled calculates the steering acceleration and writes it to the given steering output.
protected Limiter	getActualLimiter() Returns the actual limiter of this steering behavior.
Limiter	getLimiter() Returns the limiter of this steering behavior.
Steerable<T>	getOwner() Returns the owner of this steering behavior.
boolean	isEnabled() Returns true if this steering behavior is enabled; false otherwise.
protected T	newVector(Location<T> location) Utility method that creates a new vector.
SteeringBehavior<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
SteeringBehavior<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
SteeringBehavior<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.

Methods inherited from class java.lang.Object

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

Field Detail

owner

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

The owner of this steering behavior

limiter

protected Limiter limiter

The limiter of this steering behavior

enabled

protected boolean enabled

A flag indicating whether this steering behavior is enabled or not.

Constructor Detail

SteeringBehavior

public SteeringBehavior(Steerable<T> owner)

Creates a SteeringBehavior for the specified owner. The behavior is enabled and has no explicit limiter, meaning that the owner is used instead.

Parameters:

owner - the owner of this steering behavior

SteeringBehavior

public SteeringBehavior(Steerable<T> owner,
                        Limiter limiter)

Creates a SteeringBehavior for the specified owner and limiter. The behavior is enabled.

Parameters:

owner - the owner of this steering behavior

limiter - the limiter of this steering behavior

SteeringBehavior

public SteeringBehavior(Steerable<T> owner,
                        boolean enabled)

Creates a SteeringBehavior for the specified owner and activation flag. The behavior has no explicit limiter, meaning that the owner is used instead.

Parameters:

owner - the owner of this steering behavior

enabled - a flag indicating whether this steering behavior is enabled or not

SteeringBehavior

public SteeringBehavior(Steerable<T> owner,
                        Limiter limiter,
                        boolean enabled)

Creates a SteeringBehavior for the specified owner, limiter and activation flag.

Parameters:

owner - the owner of this steering behavior

limiter - the limiter of this steering behavior

enabled - a flag indicating whether this steering behavior is enabled or not

Method Detail

calculateSteering

public SteeringAcceleration<T> calculateSteering(SteeringAcceleration<T> steering)

If this behavior is enabled calculates the steering acceleration and writes it to the given steering output. If it is disabled the steering output is set to zero.

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

calculateRealSteering

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

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

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

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

getOwner

public Steerable<T> getOwner()

Returns the owner of this steering behavior.

setOwner

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

Sets the owner of this steering behavior.

Returns:

this behavior for chaining.

getLimiter

public Limiter getLimiter()

Returns the limiter of this steering behavior.

setLimiter

public SteeringBehavior<T> setLimiter(Limiter limiter)

Sets the limiter of this steering behavior.

Returns:

this behavior for chaining.

isEnabled

public boolean isEnabled()

Returns true if this steering behavior is enabled; false otherwise.

setEnabled

public SteeringBehavior<T> setEnabled(boolean enabled)

Sets this steering behavior on/off.

Returns:

this behavior for chaining.

getActualLimiter

protected Limiter getActualLimiter()

Returns the actual limiter of this steering behavior.

newVector

protected T newVector(Location<T> location)

Utility method that creates a new vector.

This method is used internally to instantiate vectors of the correct type parameter T. This technique keeps the API simple and makes the API easier to use with the GWT backend because avoids the use of reflection.

Parameters:

location - the location whose position is used to create the new vector

Returns:

the newly created vector