com.badlogic.gdx.ai.steer

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

java.lang.Object

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

Type Parameters:

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

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

SteeringAcceleration is a movement requested by the steering system. It is made up of two components, linear and angular acceleration.

Field Summary

Fields

Modifier and Type	Field and Description
float	angular The angular component of this steering acceleration.
T	linear The linear component of this steering acceleration.

Constructor Summary

Constructors

Constructor and Description
SteeringAcceleration(T linear) Creates a SteeringAcceleration with the given linear acceleration and zero angular acceleration.
SteeringAcceleration(T linear, float angular) Creates a SteeringAcceleration with the given linear and angular components.

Method Summary

Modifier and Type	Method and Description
SteeringAcceleration<T>	add(SteeringAcceleration<T> steering) Adds the given steering acceleration to this steering acceleration.
float	calculateMagnitude() Returns the magnitude of this steering acceleration.
float	calculateSquareMagnitude() Returns the square of the magnitude of this steering acceleration.
boolean	isZero() Returns true if both linear and angular components of this steering acceleration are zero; false otherwise.
SteeringAcceleration<T>	mulAdd(SteeringAcceleration<T> steering, float scalar) First scale a supplied steering acceleration, then add it to this steering acceleration.
SteeringAcceleration<T>	scl(float scalar) Scales this steering acceleration by the specified scalar.
SteeringAcceleration<T>	setZero() Zeros the linear and angular components of this steering acceleration.

Methods inherited from class java.lang.Object

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

Field Detail

linear

public T extends com.badlogic.gdx.math.Vector<T> linear

The linear component of this steering acceleration.

angular

public float angular

The angular component of this steering acceleration.

Constructor Detail

SteeringAcceleration

public SteeringAcceleration(T linear)

Creates a SteeringAcceleration with the given linear acceleration and zero angular acceleration.

Parameters:

linear - The initial linear acceleration to give this SteeringAcceleration.

SteeringAcceleration

public SteeringAcceleration(T linear,
                            float angular)

Creates a SteeringAcceleration with the given linear and angular components.

Parameters:

linear - The initial linear acceleration to give this SteeringAcceleration.

angular - The initial angular acceleration to give this SteeringAcceleration.

Method Detail

isZero

public boolean isZero()

Returns true if both linear and angular components of this steering acceleration are zero; false otherwise.

setZero

public SteeringAcceleration<T> setZero()

Zeros the linear and angular components of this steering acceleration.

Returns:

this steering acceleration for chaining

add

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

Adds the given steering acceleration to this steering acceleration.

Parameters:

steering - the steering acceleration

Returns:

this steering acceleration for chaining

scl

public SteeringAcceleration<T> scl(float scalar)

Scales this steering acceleration by the specified scalar.

Parameters:

scalar - the scalar

Returns:

this steering acceleration for chaining

mulAdd

public SteeringAcceleration<T> mulAdd(SteeringAcceleration<T> steering,
                                      float scalar)

First scale a supplied steering acceleration, then add it to this steering acceleration.

Parameters:

steering - the steering acceleration

scalar - the scalar

Returns:

this steering acceleration for chaining

calculateSquareMagnitude

public float calculateSquareMagnitude()

Returns the square of the magnitude of this steering acceleration. This includes the angular component.

calculateMagnitude

public float calculateMagnitude()

Returns the magnitude of this steering acceleration. This includes the angular component.