Module org.dyn4j

Package org.dyn4j.collision.narrowphase

Class Penetration

Object

Penetration

All Implemented Interfaces:

Copyable<Penetration>, Shiftable

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

Represents a Penetration of one Convex Shape into another.

The penetration normal should always be a normalized vector that points from the first Convex Shape to the second.

Since:

1.0.0

Version:

4.0.0

Author:

William Bittle

Constructor Summary

Constructors

Constructor	Description
Penetration()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the penetration information.
Penetration	copy()	Returns a deep copy of this object.
void	copy(Penetration penetration)	Copies (deep) the given Penetration information to this Penetration.
double	getDepth()	Returns the penetration depth.
Vector2	getNormal()	Returns the penetration normal.
void	setDepth(double depth)	Sets the penetration depth.
void	setNormal(Vector2 normal)	Sets the penetration normal.
void	shift(Vector2 shift)	Translates the object to match the given coordinate shift.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Penetration

public Penetration()

Default constructor.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Clears the penetration information.

getNormal

public Vector2 getNormal()

Returns the penetration normal.

Returns:

Vector2

getDepth

public double getDepth()

Returns the penetration depth.

Returns:

double

setNormal

public void setNormal(Vector2 normal)

Sets the penetration normal.

Must be normalized.

Parameters:

normal - the penetration normal

setDepth

public void setDepth(double depth)

Sets the penetration depth.

Parameters:

depth - the penetration depth

copy

public void copy(Penetration penetration)

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

Parameters:

penetration - the penetration 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 Penetration copy()

Description copied from interface: Copyable

Returns a deep copy of this object.

Specified by:

copy in interface Copyable<Penetration>

Returns:

T