com.badlogic.gdx.ai.steer.utils.rays

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

java.lang.Object

com.badlogic.gdx.ai.steer.utils.rays.RayConfigurationBase<T>

com.badlogic.gdx.ai.steer.utils.rays.CentralRayWithWhiskersConfiguration<T>

Type Parameters:

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

All Implemented Interfaces:

RayConfiguration<T>

public class CentralRayWithWhiskersConfiguration<T extends com.badlogic.gdx.math.Vector<T>>
extends RayConfigurationBase<T>

A CentralRayWithWhiskersConfiguration uses a long central ray and two shorter whiskers.

A central ray with short whiskers is often the best initial configuration to try but can make it impossible for the character to move down tight passages. Also, it is still susceptible to the corner trap, far less than the parallel configuration though.

Field Summary

Fields inherited from class com.badlogic.gdx.ai.steer.utils.rays.RayConfigurationBase

owner, rays

Constructor Summary

Constructors

Constructor and Description
CentralRayWithWhiskersConfiguration(Steerable<T> owner, float rayLength, float whiskerLength, float whiskerAngle) Creates a CentralRayWithWhiskersConfiguration for the given owner where the central ray has the specified length and the two whiskers have the specified length and angle.

Method Summary

Modifier and Type	Method and Description
float	getRayLength() Returns the length of the central ray.
float	getWhiskerAngle() Returns the angle in radians of the whiskers from the central ray.
float	getWhiskerLength() Returns the length of the two whiskers.
void	setRayLength(float rayLength) Sets the length of the central ray.
void	setWhiskerAngle(float whiskerAngle) Sets the angle in radians of the whiskers from the central ray.
void	setWhiskerLength(float whiskerLength) Sets the length of the two whiskers.
Ray<T>[]	updateRays()

Methods inherited from class com.badlogic.gdx.ai.steer.utils.rays.RayConfigurationBase

getOwner, getRays, setOwner, setRays

Methods inherited from class java.lang.Object

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

Constructor Detail

CentralRayWithWhiskersConfiguration

public CentralRayWithWhiskersConfiguration(Steerable<T> owner,
                                           float rayLength,
                                           float whiskerLength,
                                           float whiskerAngle)

Creates a CentralRayWithWhiskersConfiguration for the given owner where the central ray has the specified length and the two whiskers have the specified length and angle.

Parameters:

owner - the owner of this configuration

rayLength - the length of the central ray

whiskerLength - the length of the two whiskers (usually shorter than the central ray)

whiskerAngle - the angle in radians of the whiskers from the central ray

Method Detail

updateRays

public Ray<T>[] updateRays()

getRayLength

public float getRayLength()

Returns the length of the central ray.

setRayLength

public void setRayLength(float rayLength)

Sets the length of the central ray.

getWhiskerLength

public float getWhiskerLength()

Returns the length of the two whiskers.

setWhiskerLength

public void setWhiskerLength(float whiskerLength)

Sets the length of the two whiskers.

getWhiskerAngle

public float getWhiskerAngle()

Returns the angle in radians of the whiskers from the central ray.

setWhiskerAngle

public void setWhiskerAngle(float whiskerAngle)

Sets the angle in radians of the whiskers from the central ray.