com.almasb.fxgl.physics.box2d.collision.shapes

Class PolygonShape

java.lang.Object

com.almasb.fxgl.physics.box2d.collision.shapes.Shape

com.almasb.fxgl.physics.box2d.collision.shapes.PolygonShape

public final class PolygonShape
extends Shape

A convex polygon shape. Polygons have a maximum number of vertices equal to JBoxSettings.maxPolygonVertices. In most cases you should not need many vertices for a convex polygon.

Field Summary

Fields

Modifier and Type	Field and Description
Vec2	m_centroid Local position of the shape centroid in parent body frame.
Vec2[]	m_normals The normals of the shape.
Vec2[]	m_vertices The vertices of the shape.

Constructor Summary

Constructors

Constructor and Description
PolygonShape()

Method Summary

Modifier and Type	Method and Description
Vec2	centroid(Transform xf) Get the centroid and apply the supplied transform.
Vec2	centroidToOut(Transform xf, Vec2 out) Get the centroid and apply the supplied transform.
Shape	clone()
void	computeAABB(AABB aabb, Transform xf, int childIndex) Given a transform, compute the associated axis aligned bounding box for a child shape.
void	computeCentroidToOut(Vec2[] vs, int count, Vec2 out)
float	computeDistanceToOut(Transform xf, Vec2 p, int childIndex, Vec2 normalOut) Compute the distance from the current shape to the specified point.
void	computeMass(MassData massData, float density) Compute the mass properties of this shape using its dimensions and density.
int	getChildCount()
Vec2[]	getNormals() Get the edge normal vectors.
Vec2	getVertex(int index) Get a vertex by index.
int	getVertexCount()
Vec2[]	getVertices() Get the vertices in local coordinates.
boolean	raycast(RayCastOutput output, RayCastInput input, Transform xf, int childIndex) Cast a ray against a child shape.
void	set(Vec2[] vertices, int count) Create a convex hull from the given array of points.
void	setAsBox(float hx, float hy) Build vertices to represent an axis-aligned box.
void	setAsBox(float hx, float hy, Vec2 center, float angle) Build vertices to represent an oriented box.
boolean	testPoint(Transform xf, Vec2 p) Test a point for containment in this shape.
boolean	validate() Validate convexity.

Methods inherited from class com.almasb.fxgl.physics.box2d.collision.shapes.Shape

getRadius, getType, setRadius

Methods inherited from class java.lang.Object

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

Field Detail

m_centroid

public final Vec2 m_centroid

Local position of the shape centroid in parent body frame.

m_vertices

public final Vec2[] m_vertices

The vertices of the shape. Note: use getVertexCount(), not m_vertices.length, to get number of active vertices.

m_normals

public final Vec2[] m_normals

The normals of the shape. Note: use getVertexCount(), not m_normals.length, to get number of active normals.

Constructor Detail

PolygonShape

public PolygonShape()

Method Detail

clone

public Shape clone()

Specified by:

clone in class Shape

getChildCount

public int getChildCount()

Specified by:

getChildCount in class Shape

Returns:

the number of child primitives

testPoint

public boolean testPoint(Transform xf,
                         Vec2 p)

Description copied from class: Shape

Test a point for containment in this shape. This only works for convex shapes.

Specified by:

testPoint in class Shape

Parameters:

xf - the shape world transform.

p - a point in world coordinates.

computeAABB

public void computeAABB(AABB aabb,
                        Transform xf,
                        int childIndex)

Description copied from class: Shape

Given a transform, compute the associated axis aligned bounding box for a child shape.

Specified by:

computeAABB in class Shape

Parameters:

aabb - returns the axis aligned box

xf - the world transform of the shape

childIndex - the child shape index

computeDistanceToOut

public float computeDistanceToOut(Transform xf,
                                  Vec2 p,
                                  int childIndex,
                                  Vec2 normalOut)

Description copied from class: Shape

Compute the distance from the current shape to the specified point. This only works for convex shapes.

Specified by:

computeDistanceToOut in class Shape

Parameters:

xf - the shape world transform.

p - a point in world coordinates.

normalOut - returns the direction in which the distance increases.

Returns:

the distance from the current shape.

raycast

public boolean raycast(RayCastOutput output,
                       RayCastInput input,
                       Transform xf,
                       int childIndex)

Description copied from class: Shape

Cast a ray against a child shape.

Specified by:

raycast in class Shape

Parameters:

output - the ray-cast results.

input - the ray-cast input parameters.

xf - the transform to be applied to the shape.

childIndex - the child shape index

Returns:

if hit

computeMass

public void computeMass(MassData massData,
                        float density)

Description copied from class: Shape

Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin.

Specified by:

computeMass in class Shape

Parameters:

massData - returns the mass data for this shape.

density - the density in kilograms per meter squared.

set

public void set(Vec2[] vertices,
                int count)

Create a convex hull from the given array of points. The count must be in the range [3, JBoxSettings.maxPolygonVertices].

Warning:

the points may be re-ordered, even if they form a convex polygon., collinear points are removed.

setAsBox

public void setAsBox(float hx,
                     float hy)

Build vertices to represent an axis-aligned box.

Parameters:

hx - the half-width.

hy - the half-height.

setAsBox

public void setAsBox(float hx,
                     float hy,
                     Vec2 center,
                     float angle)

Build vertices to represent an oriented box.

Parameters:

hx - the half-width.

hy - the half-height.

center - the center of the box in local coordinates.

angle - the rotation of the box in local coordinates.

getVertexCount

public int getVertexCount()

getVertex

public Vec2 getVertex(int index)

Get a vertex by index.

Parameters:

index -

Returns:

computeCentroidToOut

public void computeCentroidToOut(Vec2[] vs,
                                 int count,
                                 Vec2 out)

validate

public boolean validate()

Validate convexity. This is a very time consuming operation.

Returns:

getVertices

public Vec2[] getVertices()

Get the vertices in local coordinates.

getNormals

public Vec2[] getNormals()

Get the edge normal vectors. There is one for each vertex.

centroid

public Vec2 centroid(Transform xf)

Get the centroid and apply the supplied transform.

centroidToOut

public Vec2 centroidToOut(Transform xf,
                          Vec2 out)

Get the centroid and apply the supplied transform.