Module org.dyn4j

Package org.dyn4j.geometry

Interface Shape

All Superinterfaces:

DataContainer, Rotatable, Transformable, Translatable

All Known Subinterfaces:

Convex, Wound

All Known Implementing Classes:

AbstractShape, Capsule, Circle, Ellipse, HalfEllipse, Link, Polygon, Rectangle, Segment, Slice, Triangle

public interface Shape
extends Transformable, DataContainer

Represents a geometric Shape.

The Shape class implements the Transformable interface and modifies the internal state of the Shape directly (translating the vertices for example).

The various implementing classes may allow mutation of the shape indirectly by returning mutable objects. It's recommended that a Shape, after creation and use, remain unchanged and instead be replaced with a new Shape if modification is necessary.

Since:

1.0.0

Version:

4.0.0

Author:

William Bittle

Method Summary

Modifier and Type	Method	Description
void	computeAABB(AABB aabb)	Computes the AABB from this Shape and places the result in the given AABB.
void	computeAABB(Transform transform, AABB aabb)	Computes the AABB from this Shape after applying the given transformation and places the result in the given AABB.
boolean	contains(Vector2 point)	Returns true if the given point is inside this Shape.
boolean	contains(Vector2 point, Transform transform)	Returns true if the given point is inside this Shape.
AABB	createAABB()	Creates an AABB from this Shape.
AABB	createAABB(Transform transform)	Creates an AABB from this Shape after applying the given transformation to the shape.
Mass	createMass(double density)	Creates a Mass object using the geometric properties of this Shape and the given density.
Vector2	getCenter()	Returns the center/centroid of the Shape in local coordinates.
double	getRadius()	Returns the maximum radius of the shape from the center.
double	getRadius(Vector2 center)	Returns the radius of the shape if the given point was the center for this shape.
Interval	project(Vector2 vector)	Returns the Interval of this Shape projected onto the given Vector2 given the Transform.
Interval	project(Vector2 vector, Transform transform)	Returns the Interval of this Shape projected onto the given Vector2 given the Transform.
void	rotateAboutCenter(double theta)	Rotates the Shape about it's center.

Methods inherited from interface DataContainer

getUserData, setUserData

Methods inherited from interface Rotatable

rotate, rotate, rotate, rotate, rotate, rotate

Methods inherited from interface Translatable

translate, translate

Method Detail

getCenter

Vector2 getCenter()

Returns the center/centroid of the Shape in local coordinates.

Returns:

Vector2

getRadius

double getRadius()

Returns the maximum radius of the shape from the center.

Returns:

double

Since:

2.0.0

getRadius

double getRadius(Vector2 center)

Returns the radius of the shape if the given point was the center for this shape.

Parameters:

center - the center point

Returns:

double

Throws:

NullPointerException - if the given point is null

Since:

3.0.2

rotateAboutCenter

void rotateAboutCenter(double theta)

Rotates the Shape about it's center.

This method replaced the overriding functionality of the rotate method from the Transformable interface.

Parameters:

theta - the rotation angle in radians

Since:

3.1.1

project

Interval project(Vector2 vector)

Returns the Interval of this Shape projected onto the given Vector2 given the Transform.

This is the same as calling project(Vector2, Transform) and passing a new Transform.

Parameters:

vector - Vector2 to project onto

Returns:

Interval

Throws:

NullPointerException - if the given vector is null

Since:

3.1.5

project

Interval project(Vector2 vector,
                 Transform transform)

Returns the Interval of this Shape projected onto the given Vector2 given the Transform.

Parameters:

vector - Vector2 to project onto

transform - Transform for this Shape

Returns:

Interval

Throws:

NullPointerException - if the given vector or transform is null

contains

boolean contains(Vector2 point)

Returns true if the given point is inside this Shape.

If the given point lies on an edge the point is considered to be inside the Shape.

The given point is assumed to be in world space.

This is the same as calling contains(Vector2, Transform) and passing a new Transform.

Parameters:

point - world space point

Returns:

boolean

Throws:

NullPointerException - if the given point is null

Since:

3.1.5

contains

boolean contains(Vector2 point,
                 Transform transform)

Returns true if the given point is inside this Shape.

If the given point lies on an edge the point is considered to be inside the Shape.

The given point is assumed to be in world space.

Parameters:

point - world space point

transform - Transform for this Shape

Returns:

boolean

Throws:

NullPointerException - if the given point or transform is null

createMass

Mass createMass(double density)

Creates a Mass object using the geometric properties of this Shape and the given density.

Parameters:

density - the density in kg/m²

Returns:

Mass the Mass of this Shape

createAABB

AABB createAABB()

Creates an AABB from this Shape.

This is the same as calling createAABB(Transform) and passing a new Transform.

Returns:

AABB the AABB enclosing this Shape

Since:

3.1.4

createAABB

AABB createAABB(Transform transform)

Creates an AABB from this Shape after applying the given transformation to the shape.

Parameters:

transform - the Transform for this Shape

Returns:

AABB the AABB enclosing this Shape

Throws:

NullPointerException - if the given transform is null

Since:

3.0.0

computeAABB

void computeAABB(AABB aabb)

Computes the AABB from this Shape and places the result in the given AABB.

This is the same as calling computeAABB(Transform, AABB) and passing a new Transform.

Parameters:

aabb - the destination AABB

Since:

4.0.0

computeAABB

void computeAABB(Transform transform,
                 AABB aabb)

Computes the AABB from this Shape after applying the given transformation and places the result in the given AABB.

Parameters:

transform - the Transform for this Shape

aabb - the destination AABB

Throws:

NullPointerException - if the given transform is null

Since:

4.0.0