com.badlogic.gdx.ai.steer.limiters

Class NullLimiter

java.lang.Object

com.badlogic.gdx.ai.steer.limiters.NullLimiter

All Implemented Interfaces:

Limiter

Direct Known Subclasses:

AngularAccelerationLimiter, AngularLimiter, AngularSpeedLimiter, LinearAccelerationLimiter, LinearLimiter, LinearSpeedLimiter

public class NullLimiter
extends java.lang.Object
implements Limiter

A NullLimiter always throws UnsupportedOperationException. Typically it's used as the base class of partial or immutable limiters.

Field Summary

Fields

Modifier and Type	Field and Description
static NullLimiter	NEUTRAL_LIMITER An immutable limiter whose getters return Float.POSITIVE_INFINITY and setters throw UnsupportedOperationException.

Constructor Summary

Constructors

Constructor and Description
NullLimiter() Creates a NullLimiter.

Method Summary

Modifier and Type	Method and Description
float	getMaxAngularAcceleration() Guaranteed to throw UnsupportedOperationException.
float	getMaxAngularSpeed() Guaranteed to throw UnsupportedOperationException.
float	getMaxLinearAcceleration() Guaranteed to throw UnsupportedOperationException.
float	getMaxLinearSpeed() Guaranteed to throw UnsupportedOperationException.
float	getZeroLinearSpeedThreshold() Returns the threshold below which the linear speed can be considered zero.
void	setMaxAngularAcceleration(float maxAngularAcceleration) Guaranteed to throw UnsupportedOperationException.
void	setMaxAngularSpeed(float maxAngularSpeed) Guaranteed to throw UnsupportedOperationException.
void	setMaxLinearAcceleration(float maxLinearAcceleration) Guaranteed to throw UnsupportedOperationException.
void	setMaxLinearSpeed(float maxLinearSpeed) Guaranteed to throw UnsupportedOperationException.
void	setZeroLinearSpeedThreshold(float zeroLinearSpeedThreshold) Guaranteed to throw UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Field Detail

NEUTRAL_LIMITER

public static final NullLimiter NEUTRAL_LIMITER

An immutable limiter whose getters return Float.POSITIVE_INFINITY and setters throw UnsupportedOperationException.

Constructor Detail

NullLimiter

public NullLimiter()

Creates a NullLimiter.

Method Detail

getMaxLinearSpeed

public float getMaxLinearSpeed()

Guaranteed to throw UnsupportedOperationException.

Specified by:

getMaxLinearSpeed in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

setMaxLinearSpeed

public void setMaxLinearSpeed(float maxLinearSpeed)

Guaranteed to throw UnsupportedOperationException.

Specified by:

setMaxLinearSpeed in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

getMaxLinearAcceleration

public float getMaxLinearAcceleration()

Guaranteed to throw UnsupportedOperationException.

Specified by:

getMaxLinearAcceleration in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

setMaxLinearAcceleration

public void setMaxLinearAcceleration(float maxLinearAcceleration)

Guaranteed to throw UnsupportedOperationException.

Specified by:

setMaxLinearAcceleration in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

getMaxAngularSpeed

public float getMaxAngularSpeed()

Guaranteed to throw UnsupportedOperationException.

Specified by:

getMaxAngularSpeed in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

setMaxAngularSpeed

public void setMaxAngularSpeed(float maxAngularSpeed)

Guaranteed to throw UnsupportedOperationException.

Specified by:

setMaxAngularSpeed in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

getMaxAngularAcceleration

public float getMaxAngularAcceleration()

Guaranteed to throw UnsupportedOperationException.

Specified by:

getMaxAngularAcceleration in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

setMaxAngularAcceleration

public void setMaxAngularAcceleration(float maxAngularAcceleration)

Guaranteed to throw UnsupportedOperationException.

Specified by:

setMaxAngularAcceleration in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always

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 zeroLinearSpeedThreshold)

Guaranteed to throw UnsupportedOperationException.

Specified by:

setZeroLinearSpeedThreshold in interface Limiter

Throws:

java.lang.UnsupportedOperationException - always