net.dermetfan.utils.libgdx.box2d

Class Autopilot

java.lang.Object

net.dermetfan.utils.libgdx.box2d.Autopilot

public class Autopilot
extends java.lang.Object

navigates bodies to a destination

Author:

dermetfan

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	adaptForceToMass if the force used should be adapted to the body mass
private float	angle the desired angle to destination
static net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body>	defaultPositionAccessor returns Body.getPosition()
com.badlogic.gdx.math.Vector2	destination the point to move and rotate to
private float	distanceScalar the distance at which the force should be fully applied
private com.badlogic.gdx.math.Interpolation	interpolation the interpolation to apply to the force based on the distanceScalar
private com.badlogic.gdx.math.Vector2	movementForce the force used for movement
private boolean	moveRelative if the destination is relative to the body
private net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body>	positionAccessor used to determine a bodies position
private boolean	rotateRelative if the destination is relative to the body
private float	rotationForce the force used for rotation
private static com.badlogic.gdx.math.Vector2	vec2_0 for internal, temporary usage
private static com.badlogic.gdx.math.Vector2	vec2_1 for internal, temporary usage

Constructor Summary

Constructors

Constructor and Description
Autopilot(com.badlogic.gdx.math.Vector2 destination, float angle, float forces) sets movementForce and rotationForce to the given force
Autopilot(com.badlogic.gdx.math.Vector2 destination, float angle, com.badlogic.gdx.math.Vector2 movementForce, float rotationForce)
Autopilot(com.badlogic.gdx.math.Vector2 destination, float angle, com.badlogic.gdx.math.Vector2 movementForce, float rotationForce, boolean adaptForceToMass) The given destination will not be used directly.

Method Summary

Modifier and Type	Method and Description
static com.badlogic.gdx.math.Vector2	calculateForce(com.badlogic.gdx.math.Vector2 destination, com.badlogic.gdx.math.Vector2 force) calculates the force to continuously apply to reach the given destination
static com.badlogic.gdx.math.Vector2	calculateForce(com.badlogic.gdx.math.Vector2 destination, com.badlogic.gdx.math.Vector2 force, float distanceScalar, com.badlogic.gdx.math.Interpolation interpolation) calculates the force to continuously apply to reach the given destination and interpolates it based on distance
static float	calculateTorque(com.badlogic.gdx.math.Vector2 target, float rotation, float angularVelocity, float inertia, float force, float delta) calculates the torque needed to repeatedly apply to a body to make it rotate to a given point
float	getAngle()
com.badlogic.gdx.math.Vector2	getDestination()
float	getDistanceScalar()
com.badlogic.gdx.math.Interpolation	getInterpolation()
com.badlogic.gdx.math.Vector2	getMovementForce()
net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body>	getPositionAccessor()
float	getRotationForce()
boolean	isAdaptForceToMass()
boolean	isMoveRelative()
boolean	isRotateRelative()
void	move(com.badlogic.gdx.physics.box2d.Body body, boolean interpolate, boolean wake) moves/moves the given Body
void	move(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.math.Vector2 destination, com.badlogic.gdx.math.Vector2 force, boolean wake) applies the force from calculateForce(Vector2, Vector2)
void	move(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.math.Vector2 destination, com.badlogic.gdx.math.Vector2 force, com.badlogic.gdx.math.Interpolation interpolation, float distanceScalar, boolean wake) applies the force of calculateForce(Vector2, Vector2, float, Interpolation)
void	navigate(com.badlogic.gdx.physics.box2d.Body body, float delta)
void	navigate(com.badlogic.gdx.physics.box2d.Body body, float delta, boolean wake)
void	navigate(com.badlogic.gdx.physics.box2d.Body body, float delta, boolean interpolate, boolean wake) rotates and moves the given body
void	rotate(com.badlogic.gdx.physics.box2d.Body body, float delta) rotates the body waking it up if it sleeps
void	rotate(com.badlogic.gdx.physics.box2d.Body body, float delta, boolean wake) rotates the given body
void	rotate(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.math.Vector2 target, float angle, float force, float delta, boolean wake)
void	setAdaptForceToMass(boolean adaptForceToMass)
void	setAngle(float angle)
void	setDestination(float x, float y)
void	setDestination(com.badlogic.gdx.math.Vector2 destination)
void	setDistanceScalar(float distanceScalar)
void	setForces(float movementForceX, float movementForceY, float rotationForce)
void	setForces(com.badlogic.gdx.math.Vector2 movementForce, float rotationForce)
void	setInterpolation(com.badlogic.gdx.math.Interpolation interpolation)
void	setMovementForce(float x, float y)
void	setMovementForce(com.badlogic.gdx.math.Vector2 movementForce)
void	setMoveRelative(boolean moveRelative)
void	setPositionAccessor(net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body> positionAccessor)
void	setRelative(boolean relative)
void	setRelative(boolean moveRelative, boolean rotateRelative)
void	setRotateRelative(boolean rotateRelative)
void	setRotationForce(float rotationForce)

Methods inherited from class java.lang.Object

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

Field Detail

vec2_0

private static final com.badlogic.gdx.math.Vector2 vec2_0

for internal, temporary usage

vec2_1

private static final com.badlogic.gdx.math.Vector2 vec2_1

for internal, temporary usage

destination

public final com.badlogic.gdx.math.Vector2 destination

the point to move and rotate to

angle

private float angle

the desired angle to destination

moveRelative

private boolean moveRelative

if the destination is relative to the body

rotateRelative

private boolean rotateRelative

if the destination is relative to the body

movementForce

private final com.badlogic.gdx.math.Vector2 movementForce

the force used for movement

rotationForce

private float rotationForce

the force used for rotation

adaptForceToMass

private boolean adaptForceToMass

if the force used should be adapted to the body mass

distanceScalar

private float distanceScalar

the distance at which the force should be fully applied

See Also:

calculateForce(Vector2, Vector2, float, Interpolation)

interpolation

private com.badlogic.gdx.math.Interpolation interpolation

the interpolation to apply to the force based on the distanceScalar

defaultPositionAccessor

public static final net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body> defaultPositionAccessor

returns Body.getPosition()

positionAccessor

private net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body> positionAccessor

used to determine a bodies position

Constructor Detail

Autopilot

public Autopilot(com.badlogic.gdx.math.Vector2 destination,
                 float angle,
                 float forces)

sets movementForce and rotationForce to the given force

See Also:

Autopilot(Vector2, float, float)

Autopilot

public Autopilot(com.badlogic.gdx.math.Vector2 destination,
                 float angle,
                 com.badlogic.gdx.math.Vector2 movementForce,
                 float rotationForce)

See Also:

Autopilot(Vector2, float, Vector2, float, boolean)

Autopilot

public Autopilot(com.badlogic.gdx.math.Vector2 destination,
                 float angle,
                 com.badlogic.gdx.math.Vector2 movementForce,
                 float rotationForce,
                 boolean adaptForceToMass)

The given destination will not be used directly. Instead destination will be set to it.

Method Detail

calculateForce

public static com.badlogic.gdx.math.Vector2 calculateForce(com.badlogic.gdx.math.Vector2 destination,
                                                           com.badlogic.gdx.math.Vector2 force)

calculates the force to continuously apply to reach the given destination

Parameters:

destination - the relative position of the destination

force - the force to apply

Returns:

the force to apply to navigate to the given destination

calculateForce

public static com.badlogic.gdx.math.Vector2 calculateForce(com.badlogic.gdx.math.Vector2 destination,
                                                           com.badlogic.gdx.math.Vector2 force,
                                                           float distanceScalar,
                                                           com.badlogic.gdx.math.Interpolation interpolation)

calculates the force to continuously apply to reach the given destination and interpolates it based on distance

Parameters:

destination - the destination to go to

force - the force to apply

distanceScalar - the distance at which the given force should be fully applied

interpolation - the interpolation used to interpolate the given force based on the distanceScalar

Returns:

the force to apply to navigate to the given destination

See Also:

calculateForce(Vector2, Vector2)

calculateTorque

public static float calculateTorque(com.badlogic.gdx.math.Vector2 target,
                                    float rotation,
                                    float angularVelocity,
                                    float inertia,
                                    float force,
                                    float delta)

calculates the torque needed to repeatedly apply to a body to make it rotate to a given point

Parameters:

target - the point to rotate the body to

rotation - the current rotation of the body

angularVelocity - the current angular velocity of the body

inertia - the current rotational inertia of the body

force - the force to use

delta - the time that passed since the last world update

Returns:

the torque needed to apply to a body to make it rotate to the given target

move

public void move(com.badlogic.gdx.physics.box2d.Body body,
                 com.badlogic.gdx.math.Vector2 destination,
                 com.badlogic.gdx.math.Vector2 force,
                 boolean wake)

applies the force from calculateForce(Vector2, Vector2)

See Also:

calculateForce(Vector2, Vector2), move(Body, Vector2, Vector2, Interpolation, float, boolean)

move

public void move(com.badlogic.gdx.physics.box2d.Body body,
                 com.badlogic.gdx.math.Vector2 destination,
                 com.badlogic.gdx.math.Vector2 force,
                 com.badlogic.gdx.math.Interpolation interpolation,
                 float distanceScalar,
                 boolean wake)

applies the force of calculateForce(Vector2, Vector2, float, Interpolation)

Parameters:

body - the body to move

destination - the destination of the body

force - the force used to move the body

interpolation - the interpolation used to interpolate the given force based on the distanceScalar

distanceScalar - the distance at which the force should be fully applied

wake - if the body should be woken up in case it is sleeping

See Also:

move(Body, Vector2, Vector2, boolean), calculateForce(Vector2, Vector2, float, Interpolation)

move

public void move(com.badlogic.gdx.physics.box2d.Body body,
                 boolean interpolate,
                 boolean wake)

moves/moves the given Body

rotate

public void rotate(com.badlogic.gdx.physics.box2d.Body body,
                   com.badlogic.gdx.math.Vector2 target,
                   float angle,
                   float force,
                   float delta,
                   boolean wake)

Parameters:

wake - if the body should be woken up if its sleeping

See Also:

calculateTorque(Vector2, float, float, float, float, float)

rotate

public void rotate(com.badlogic.gdx.physics.box2d.Body body,
                   float delta,
                   boolean wake)

rotates the given body

rotate

public void rotate(com.badlogic.gdx.physics.box2d.Body body,
                   float delta)

rotates the body waking it up if it sleeps

navigate

public void navigate(com.badlogic.gdx.physics.box2d.Body body,
                     float delta,
                     boolean interpolate,
                     boolean wake)

rotates and moves the given body

navigate

public void navigate(com.badlogic.gdx.physics.box2d.Body body,
                     float delta,
                     boolean wake)

See Also:

navigate(Body, float, boolean, boolean)

navigate

public void navigate(com.badlogic.gdx.physics.box2d.Body body,
                     float delta)

See Also:

navigate(Body, float, boolean)

setDestination

public void setDestination(float x,
                           float y)

Parameters:

x - the x coordinate to set destination to

y - the y coordinate to set destination to

setDestination

public void setDestination(com.badlogic.gdx.math.Vector2 destination)

Parameters:

destination - the destination to set destination to

getDestination

public com.badlogic.gdx.math.Vector2 getDestination()

Returns:

the destination

getAngle

public float getAngle()

Returns:

the angle

setAngle

public void setAngle(float angle)

Parameters:

angle - the angle to set

setRelative

public void setRelative(boolean relative)

Parameters:

relative - the moveRelative and rotateRelative

setRelative

public void setRelative(boolean moveRelative,
                        boolean rotateRelative)

Parameters:

moveRelative - the moveRelative

rotateRelative - the rotateRelative

isMoveRelative

public boolean isMoveRelative()

Returns:

the moveRelative

setMoveRelative

public void setMoveRelative(boolean moveRelative)

Parameters:

moveRelative - the moveRelative to set

isRotateRelative

public boolean isRotateRelative()

Returns:

the rotateRelative

setRotateRelative

public void setRotateRelative(boolean rotateRelative)

Parameters:

rotateRelative - the rotateRelative to set

setForces

public void setForces(float movementForceX,
                      float movementForceY,
                      float rotationForce)

Parameters:

movementForceX - the x value of movementForce

movementForceY - the y value of movementForce

rotationForce - the rotationForce

setForces

public void setForces(com.badlogic.gdx.math.Vector2 movementForce,
                      float rotationForce)

Parameters:

movementForce - the movementForce

rotationForce - the rotationForce

getMovementForce

public com.badlogic.gdx.math.Vector2 getMovementForce()

Returns:

the movementForce

setMovementForce

public void setMovementForce(float x,
                             float y)

Parameters:

x - the x to set movementForce to

y - the y to set movementForce to

setMovementForce

public void setMovementForce(com.badlogic.gdx.math.Vector2 movementForce)

Parameters:

movementForce - the movementForce to set

getRotationForce

public float getRotationForce()

Returns:

the rotationForce

setRotationForce

public void setRotationForce(float rotationForce)

Parameters:

rotationForce - the rotationForce to set

isAdaptForceToMass

public boolean isAdaptForceToMass()

Returns:

the adaptForceToMass

setAdaptForceToMass

public void setAdaptForceToMass(boolean adaptForceToMass)

Parameters:

adaptForceToMass - the adaptForceToMass to set

getDistanceScalar

public float getDistanceScalar()

Returns:

the distanceScalar

setDistanceScalar

public void setDistanceScalar(float distanceScalar)

Parameters:

distanceScalar - the distanceScalar to set

getInterpolation

public com.badlogic.gdx.math.Interpolation getInterpolation()

Returns:

the interpolation

setInterpolation

public void setInterpolation(com.badlogic.gdx.math.Interpolation interpolation)

Parameters:

interpolation - the interpolation to set

getPositionAccessor

public net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body> getPositionAccessor()

Returns:

the positionAccessor

setPositionAccessor

public void setPositionAccessor(net.dermetfan.utils.Accessor<com.badlogic.gdx.math.Vector2,com.badlogic.gdx.physics.box2d.Body> positionAccessor)

Parameters:

positionAccessor - the positionAccessor to set