Module org.dyn4j

Package org.dyn4j.geometry

Interface Convex

All Superinterfaces:

DataContainer, Rotatable, Shape, Transformable, Translatable

All Known Implementing Classes:

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

public interface Convex
extends Shape, Transformable, DataContainer

Represents a Convex Shape.

A Convex Shape is a Shape that given a line, the line will only intersect at most 2 non-coincident non-colinear edges.

Working with convex shapes specifically allows collision detection algorithms to be very fast. If non-convex shapes are required, they are typically handled by attaching multiple convex shapes together.

Since:

1.0.0

Version:

1.0.3

Author:

William Bittle

Method Summary

Modifier and Type	Method	Description
Vector2[]	getAxes(Vector2[] foci, Transform transform)	Returns an array of separating axes to test for this Shape.
Feature	getFarthestFeature(Vector2 vector, Transform transform)	Returns the Feature farthest in the direction of the given vector.
Vector2	getFarthestPoint(Vector2 vector, Transform transform)	Returns the point farthest in the direction of the given vector.
Vector2[]	getFoci(Transform transform)	Returns an array of world space foci points for circular curved edges.

Methods inherited from interface DataContainer

getUserData, setUserData

Methods inherited from interface Rotatable

rotate, rotate, rotate, rotate, rotate, rotate

Methods inherited from interface Shape

computeAABB, computeAABB, contains, contains, createAABB, createAABB, createMass, getCenter, getRadius, getRadius, project, project, rotateAboutCenter

Methods inherited from interface Translatable

translate, translate

Method Detail

getAxes

Vector2[] getAxes(Vector2[] foci,
                  Transform transform)

Returns an array of separating axes to test for this Shape.

The foci parameter is an array of circular focal points of the other Shape.

If foci points are given, this method will return the separating axes for this Shape's voronoi regions also. The points in the foci array are assumed to be in world space.

The returned axes are normalized and in world space.

Parameters:

foci - the world space points representing foci of curved Shapes; can be null

transform - the local to world space Transform of this Convex Shape

Returns:

Vector2[]

Throws:

UnsupportedOperationException - if this shape doesn't support this method

getFoci

Vector2[] getFoci(Transform transform)

Returns an array of world space foci points for circular curved edges.

This method returns null if the Shape has zero curved edges.

The returned points are in world space.

Parameters:

transform - the local to world space Transform of this Convex Shape

Returns:

Vector2[]

Throws:

UnsupportedOperationException - if this shape doesn't support this method

getFarthestFeature

Feature getFarthestFeature(Vector2 vector,
                           Transform transform)

Returns the Feature farthest in the direction of the given vector.

The returned feature is in world space.

Parameters:

vector - the direction

transform - the local to world space Transform of this Convex Shape

Returns:

Feature

getFarthestPoint

Vector2 getFarthestPoint(Vector2 vector,
                         Transform transform)

Returns the point farthest in the direction of the given vector. If two points are equally distant along the given Vector2 the first one is used.

The returned point is in world space.

Parameters:

vector - the direction

transform - the local to world space Transform of this Convex Shape

Returns:

Vector2