Module org.dyn4j

Package org.dyn4j.collision.narrowphase

Class Raycast

Object

Raycast

All Implemented Interfaces:

Copyable<Raycast>, Shiftable

public class Raycast
extends Object
implements Shiftable, Copyable<Raycast>

Represents the result of a Ray cast against (intersecting with) a Convex Shape.

The point is the point on the Convex Shape where the ray intersects. The normal is the normal of the edge the Ray intersects.

Since:

2.0.0

Version:

4.0.0

Author:

William Bittle

Field Summary

Fields

Modifier and Type	Field	Description
protected double	distance	The distance from the start of the Ray to the hit point
protected Vector2	normal	The normal at the hit point
protected Vector2	point	The hit point

Constructor Summary

Constructors

Modifier	Constructor	Description
	Raycast()	Default constructor.
protected	Raycast(Vector2 point, Vector2 normal, double distance)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this object setting all values to their default values.
Raycast	copy()	Returns a deep copy of this object.
void	copy(Raycast raycast)	Copies (deep) the given Raycast information to this Raycast.
double	getDistance()	Returns the distance from the start of the Ray to the hit point.
Vector2	getNormal()	Returns the normal at the hit point.
Vector2	getPoint()	Returns the hit point.
void	setDistance(double distance)	Sets the distance from the start of the Ray to the hit point.
void	setNormal(Vector2 normal)	Sets the normal at the hit point.
void	setPoint(Vector2 point)	Sets the hit point.
void	shift(Vector2 shift)	Translates the object to match the given coordinate shift.
String	toString()

Methods inherited from class Object

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

Field Detail

point

protected final Vector2 point

The hit point

normal

protected final Vector2 normal

The normal at the hit point

distance

protected double distance

The distance from the start of the Ray to the hit point

Constructor Detail

Raycast

public Raycast()

Default constructor.

Raycast

protected Raycast(Vector2 point,
                  Vector2 normal,
                  double distance)

Full constructor.

Parameters:

point - the hit point

normal - the normal at the hit point

distance - the distance from the start of the Ray to the hit point

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Clears this object setting all values to their default values.

getPoint

public Vector2 getPoint()

Returns the hit point.

Returns:

Vector2

setPoint

public void setPoint(Vector2 point)

Sets the hit point.

Parameters:

point - the hit point

getNormal

public Vector2 getNormal()

Returns the normal at the hit point.

Returns:

Vector2

setNormal

public void setNormal(Vector2 normal)

Sets the normal at the hit point.

Parameters:

normal - the normal at the hit point

getDistance

public double getDistance()

Returns the distance from the start of the Ray to the hit point.

Returns:

double

setDistance

public void setDistance(double distance)

Sets the distance from the start of the Ray to the hit point.

Parameters:

distance - the distance

copy

public void copy(Raycast raycast)

Copies (deep) the given Raycast information to this Raycast.

Parameters:

raycast - the raycast to copy

Since:

4.0.0

shift

public void shift(Vector2 shift)

Description copied from interface: Shiftable

Translates the object to match the given coordinate shift.

Specified by:

shift in interface Shiftable

Parameters:

shift - the amount to shift along the x and y axes

copy

public Raycast copy()

Description copied from interface: Copyable

Returns a deep copy of this object.

Specified by:

copy in interface Copyable<Raycast>

Returns:

T