com.badlogic.gdx.ai.steer.utils.paths

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

java.lang.Object

com.badlogic.gdx.ai.steer.utils.paths.LinePath<T>

Type Parameters:

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

All Implemented Interfaces:

Path<T,LinePath.LinePathParam>

public class LinePath<T extends com.badlogic.gdx.math.Vector<T>>
extends java.lang.Object
implements Path<T,LinePath.LinePathParam>

A LinePath is a path for path following behaviors that is made up of a series of waypoints. Each waypoint is connected to the successor with a LinePath.Segment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinePath.LinePathParam A LinePathParam contains the status of a LinePath.
static class	LinePath.Segment<T extends com.badlogic.gdx.math.Vector<T>> A Segment connects two consecutive waypoints of a LinePath.

Nested classes/interfaces inherited from interface com.badlogic.gdx.ai.steer.utils.Path

Path.PathParam

Constructor Summary

Constructors

Constructor and Description
LinePath(com.badlogic.gdx.utils.Array<T> waypoints) Creates a closed LinePath for the specified waypoints.
LinePath(com.badlogic.gdx.utils.Array<T> waypoints, boolean isOpen) Creates a LinePath for the specified waypoints.

Method Summary

Modifier and Type	Method and Description
float	calculateDistance(T agentCurrPos, LinePath.LinePathParam parameter) Maps the given position to the nearest point along the path using the path parameter to ensure coherence and returns the distance of that nearest point from the start of the path.
float	calculatePointSegmentSquareDistance(T out, T a, T b, T c) Returns the square distance of the nearest point on line segment a-b, from point c.
void	calculateTargetPosition(T out, LinePath.LinePathParam param, float targetDistance) Calculates the target position on the path based on its distance from the start and the path parameter.
LinePath.LinePathParam	createParam() Returns a new instance of the path parameter.
void	createPath(com.badlogic.gdx.utils.Array<T> waypoints) Sets up this Path using the given way points.
T	getEndPoint() Returns the last point of this path.
float	getLength() Returns the length of this path.
com.badlogic.gdx.utils.Array<LinePath.Segment<T>>	getSegments()
T	getStartPoint() Returns the first point of this path.
boolean	isOpen() Returns true if this path is open; false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinePath

public LinePath(com.badlogic.gdx.utils.Array<T> waypoints)

Creates a closed LinePath for the specified waypoints.

Parameters:

waypoints - the points making up the path

Throws:

java.lang.IllegalArgumentException - if waypoints is null or has less than two (2) waypoints.

LinePath

public LinePath(com.badlogic.gdx.utils.Array<T> waypoints,
                boolean isOpen)

Creates a LinePath for the specified waypoints.

Parameters:

waypoints - the points making up the path

isOpen - a flag indicating whether the path is open or not

Throws:

java.lang.IllegalArgumentException - if waypoints is null or has less than two (2) waypoints.

Method Detail

isOpen

public boolean isOpen()

Description copied from interface: Path

Returns true if this path is open; false otherwise.

Specified by:

isOpen in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

getLength

public float getLength()

Description copied from interface: Path

Returns the length of this path.

Specified by:

getLength in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

getStartPoint

public T getStartPoint()

Description copied from interface: Path

Returns the first point of this path.

Specified by:

getStartPoint in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

getEndPoint

public T getEndPoint()

Description copied from interface: Path

Returns the last point of this path.

Specified by:

getEndPoint in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

calculatePointSegmentSquareDistance

public float calculatePointSegmentSquareDistance(T out,
                                                 T a,
                                                 T b,
                                                 T c)

Returns the square distance of the nearest point on line segment a-b, from point c. Also, the out vector is assigned to the nearest point.

Parameters:

out - the output vector that contains the nearest point on return

a - the start point of the line segment

b - the end point of the line segment

c - the point to calculate the distance from

createParam

public LinePath.LinePathParam createParam()

Description copied from interface: Path

Returns a new instance of the path parameter.

Specified by:

createParam in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

calculateDistance

public float calculateDistance(T agentCurrPos,
                               LinePath.LinePathParam parameter)

Description copied from interface: Path

Maps the given position to the nearest point along the path using the path parameter to ensure coherence and returns the distance of that nearest point from the start of the path.

Specified by:

calculateDistance in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

Parameters:

agentCurrPos - a location in game space

parameter - the path parameter

Returns:

the distance of the nearest point along the path from the start of the path itself.

calculateTargetPosition

public void calculateTargetPosition(T out,
                                    LinePath.LinePathParam param,
                                    float targetDistance)

Description copied from interface: Path

Calculates the target position on the path based on its distance from the start and the path parameter.

Specified by:

calculateTargetPosition in interface Path<T extends com.badlogic.gdx.math.Vector<T>,LinePath.LinePathParam>

Parameters:

out - the target position to calculate

param - the path parameter

targetDistance - the distance of the target position from the start of the path

createPath

public void createPath(com.badlogic.gdx.utils.Array<T> waypoints)

Sets up this Path using the given way points.

Parameters:

waypoints - The way points of this path.

Throws:

java.lang.IllegalArgumentException - if waypoints is null or empty.

getSegments

public com.badlogic.gdx.utils.Array<LinePath.Segment<T>> getSegments()