com.badlogic.gdx.ai.steer

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

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

Limiter, Steerable<T>, Location<T>

public class SteerableAdapter<T extends com.badlogic.gdx.math.Vector<T>>
extends java.lang.Object
implements Steerable<T>

An adapter class for Steerable. You can derive from this and only override what you are interested in. For example, this comes in handy when you have to create on the fly a target for a particular behavior.

Constructor Summary

Constructors

Constructor and Description
SteerableAdapter()

Method Summary

Modifier and Type	Method and Description
T	angleToVector(T outVector, float angle) Returns the unit vector in the direction of the specified angle expressed in radians.
float	getAngularVelocity() Returns the float value indicating the the angular velocity in radians of this Steerable.
float	getBoundingRadius() Returns the bounding radius of this Steerable.
T	getLinearVelocity() Returns the vector indicating the linear velocity of this Steerable.
float	getMaxAngularAcceleration() Returns the maximum angular acceleration.
float	getMaxAngularSpeed() Returns the maximum angular speed.
float	getMaxLinearAcceleration() Returns the maximum linear acceleration.
float	getMaxLinearSpeed() Returns the maximum linear speed.
float	getOrientation() Returns the float value indicating the orientation of this location.
T	getPosition() Returns the vector indicating the position of this location.
float	getZeroLinearSpeedThreshold() Returns the threshold below which the linear speed can be considered zero.
boolean	isTagged() Returns true if this Steerable is tagged; false otherwise.
Location<T>	newLocation() Creates a new location.
void	setMaxAngularAcceleration(float maxAngularAcceleration) Sets the maximum angular acceleration.
void	setMaxAngularSpeed(float maxAngularSpeed) Sets the maximum angular speed.
void	setMaxLinearAcceleration(float maxLinearAcceleration) Sets the maximum linear acceleration.
void	setMaxLinearSpeed(float maxLinearSpeed) Sets the maximum linear speed.
void	setOrientation(float orientation) Sets the orientation of this location, i.e.
void	setTagged(boolean tagged) Tag/untag this Steerable.
void	setZeroLinearSpeedThreshold(float value) Sets the threshold below which the linear speed can be considered zero.
float	vectorToAngle(T vector) Returns the angle in radians pointing along the specified vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

SteerableAdapter

public SteerableAdapter()

Method Detail

getZeroLinearSpeedThreshold

public float getZeroLinearSpeedThreshold()

Description copied from interface: Limiter

Returns the threshold below which the linear speed can be considered zero. It must be a small positive value near to zero. Usually it is used to avoid updating the orientation when the velocity vector has a negligible length.

Specified by:

getZeroLinearSpeedThreshold in interface Limiter

setZeroLinearSpeedThreshold

public void setZeroLinearSpeedThreshold(float value)

Description copied from interface: Limiter

Sets the threshold below which the linear speed can be considered zero. It must be a small positive value near to zero. Usually it is used to avoid updating the orientation when the velocity vector has a negligible length.

Specified by:

setZeroLinearSpeedThreshold in interface Limiter

getMaxLinearSpeed

public float getMaxLinearSpeed()

Description copied from interface: Limiter

Returns the maximum linear speed.

Specified by:

getMaxLinearSpeed in interface Limiter

setMaxLinearSpeed

public void setMaxLinearSpeed(float maxLinearSpeed)

Description copied from interface: Limiter

Sets the maximum linear speed.

Specified by:

setMaxLinearSpeed in interface Limiter

getMaxLinearAcceleration

public float getMaxLinearAcceleration()

Description copied from interface: Limiter

Returns the maximum linear acceleration.

Specified by:

getMaxLinearAcceleration in interface Limiter

setMaxLinearAcceleration

public void setMaxLinearAcceleration(float maxLinearAcceleration)

Description copied from interface: Limiter

Sets the maximum linear acceleration.

Specified by:

setMaxLinearAcceleration in interface Limiter

getMaxAngularSpeed

public float getMaxAngularSpeed()

Description copied from interface: Limiter

Returns the maximum angular speed.

Specified by:

getMaxAngularSpeed in interface Limiter

setMaxAngularSpeed

public void setMaxAngularSpeed(float maxAngularSpeed)

Description copied from interface: Limiter

Sets the maximum angular speed.

Specified by:

setMaxAngularSpeed in interface Limiter

getMaxAngularAcceleration

public float getMaxAngularAcceleration()

Description copied from interface: Limiter

Returns the maximum angular acceleration.

Specified by:

getMaxAngularAcceleration in interface Limiter

setMaxAngularAcceleration

public void setMaxAngularAcceleration(float maxAngularAcceleration)

Description copied from interface: Limiter

Sets the maximum angular acceleration.

Specified by:

setMaxAngularAcceleration in interface Limiter

getPosition

public T getPosition()

Description copied from interface: Location

Returns the vector indicating the position of this location.

Specified by:

getPosition in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

getOrientation

public float getOrientation()

Description copied from interface: Location

Returns the float value indicating the orientation of this location. The orientation is the angle in radians representing the direction that this location is facing.

Specified by:

getOrientation in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

setOrientation

public void setOrientation(float orientation)

Description copied from interface: Location

Sets the orientation of this location, i.e. the angle in radians representing the direction that this location is facing.

Specified by:

setOrientation in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

orientation - the orientation in radians

getLinearVelocity

public T getLinearVelocity()

Description copied from interface: Steerable

Returns the vector indicating the linear velocity of this Steerable.

Specified by:

getLinearVelocity in interface Steerable<T extends com.badlogic.gdx.math.Vector<T>>

getAngularVelocity

public float getAngularVelocity()

Description copied from interface: Steerable

Returns the float value indicating the the angular velocity in radians of this Steerable.

Specified by:

getAngularVelocity in interface Steerable<T extends com.badlogic.gdx.math.Vector<T>>

getBoundingRadius

public float getBoundingRadius()

Description copied from interface: Steerable

Returns the bounding radius of this Steerable.

Specified by:

getBoundingRadius in interface Steerable<T extends com.badlogic.gdx.math.Vector<T>>

isTagged

public boolean isTagged()

Description copied from interface: Steerable

Returns true if this Steerable is tagged; false otherwise.

Specified by:

isTagged in interface Steerable<T extends com.badlogic.gdx.math.Vector<T>>

setTagged

public void setTagged(boolean tagged)

Description copied from interface: Steerable

Tag/untag this Steerable. This is a generic flag utilized in a variety of ways.

Specified by:

setTagged in interface Steerable<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

tagged - the boolean value to set

newLocation

public Location<T> newLocation()

Description copied from interface: Location

Creates a new location.

This method is used internally to instantiate locations 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.

Specified by:

newLocation in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

the newly created location.

vectorToAngle

public float vectorToAngle(T vector)

Description copied from interface: Location

Returns the angle in radians pointing along the specified vector.

Specified by:

vectorToAngle in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

vector - the vector

angleToVector

public T angleToVector(T outVector,
                       float angle)

Description copied from interface: Location

Returns the unit vector in the direction of the specified angle expressed in radians.

Specified by:

angleToVector in interface Location<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

outVector - the output vector.

angle - the angle in radians.

Returns:

the output vector for chaining.