net.dermetfan.utils.libgdx.box2d

Class Box2DUtils

java.lang.Object

net.dermetfan.utils.libgdx.box2d.Box2DUtils

public abstract class Box2DUtils
extends java.lang.Object

provides methods for operations with Box2D Bodies, Fixtures and Shapes

Author:

dermetfan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Box2DUtils.ShapeCache cached method results

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	autoCache if shapes should automatically be cached when they are inspected for the first time
static com.badlogic.gdx.utils.ObjectMap<com.badlogic.gdx.physics.box2d.Shape,Box2DUtils.ShapeCache>	cache Cached Shapes and their Box2DUtils.ShapeCache.
static boolean	checkPreconditions if Box2D preconditions should be checked to avoid crashes
static byte	maxPolygonVertices the max amount of vertices of a PolygonShape (limitation by Box2D)
static float	minExclusivePolygonArea the area that is too small for a PolygonShape to contain it (limitation by Box2D)
private static com.badlogic.gdx.math.Vector2	vec2_0 for internal, temporary usage
private static com.badlogic.gdx.math.Vector2	vec2_1 for internal, temporary usage

Constructor Summary

Constructors

Constructor and Description
Box2DUtils()

Method Summary

Modifier and Type	Method and Description
static Box2DUtils.ShapeCache	cache(com.badlogic.gdx.physics.box2d.Shape shape)
static com.badlogic.gdx.physics.box2d.Body	clone(com.badlogic.gdx.physics.box2d.Body body) clones a Body (without deep copying the Shapes of its Fixtures)
static com.badlogic.gdx.physics.box2d.Body	clone(com.badlogic.gdx.physics.box2d.Body body, boolean shapes) clones a Body
static com.badlogic.gdx.physics.box2d.Fixture	clone(com.badlogic.gdx.physics.box2d.Fixture fixture, com.badlogic.gdx.physics.box2d.Body body) clones a Fixture (without deep copying its Shape)
static com.badlogic.gdx.physics.box2d.Fixture	clone(com.badlogic.gdx.physics.box2d.Fixture fixture, com.badlogic.gdx.physics.box2d.Body body, boolean shape) clones a Fixture
static <T extends com.badlogic.gdx.physics.box2d.Shape> T	clone(T shape) creates a deep copy of a Shape Note: The previous and next vertex of a ChainShape will not be copied since this is not possible due to the API.
static com.badlogic.gdx.physics.box2d.BodyDef	createDef(com.badlogic.gdx.physics.box2d.Body body)
static com.badlogic.gdx.physics.box2d.FixtureDef	createDef(com.badlogic.gdx.physics.box2d.Fixture fixture)
static void	destroyFixtures(com.badlogic.gdx.physics.box2d.Body body) destroys all fixtures of the given body
static void	destroyFixtures(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.utils.Array<com.badlogic.gdx.physics.box2d.Fixture> exclude) destroys all fixtures of the given body except the given ones
static void	destroyFixtures(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.physics.box2d.Fixture... exclude)
static void	destroyFixtures(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.physics.box2d.Fixture exclude)
static com.badlogic.gdx.math.Vector2[][]	fixtureVertices(com.badlogic.gdx.physics.box2d.Body body)
static float	height(com.badlogic.gdx.physics.box2d.Body body)
static float	height(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	height(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	height0(com.badlogic.gdx.physics.box2d.Shape shape)
static float	maxX(com.badlogic.gdx.physics.box2d.Body body)
static float	maxX(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	maxX(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	maxX0(com.badlogic.gdx.physics.box2d.Shape shape)
static float	maxY(com.badlogic.gdx.physics.box2d.Body body)
static float	maxY(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	maxY(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	maxY0(com.badlogic.gdx.physics.box2d.Shape shape)
static float	minX(com.badlogic.gdx.physics.box2d.Body body)
static float	minX(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	minX(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	minX0(com.badlogic.gdx.physics.box2d.Shape shape)
static float	minY(com.badlogic.gdx.physics.box2d.Body body)
static float	minY(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	minY(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	minY0(com.badlogic.gdx.physics.box2d.Shape shape)
static com.badlogic.gdx.math.Vector2	position(com.badlogic.gdx.physics.box2d.Fixture fixture)
static com.badlogic.gdx.math.Vector2	position(com.badlogic.gdx.physics.box2d.Shape shape, com.badlogic.gdx.physics.box2d.Body body)
static com.badlogic.gdx.math.Vector2	positionRelative(com.badlogic.gdx.physics.box2d.CircleShape shape)
static com.badlogic.gdx.math.Vector2	positionRelative(com.badlogic.gdx.physics.box2d.Fixture fixture)
static com.badlogic.gdx.math.Vector2	positionRelative(com.badlogic.gdx.physics.box2d.Shape shape, float rotation)
static void	setSensor(com.badlogic.gdx.physics.box2d.Body body, boolean sensor) sets the sensor flag of all of the given Body's Fixtures
static com.badlogic.gdx.math.Vector2	size(com.badlogic.gdx.physics.box2d.Body body)
static com.badlogic.gdx.math.Vector2	size(com.badlogic.gdx.physics.box2d.Fixture fixture)
static com.badlogic.gdx.math.Vector2	size(com.badlogic.gdx.physics.box2d.Shape shape)
private static com.badlogic.gdx.math.Vector2	size0(com.badlogic.gdx.physics.box2d.Shape shape)
static boolean	split(com.badlogic.gdx.physics.box2d.Body body, com.badlogic.gdx.math.Vector2 a, com.badlogic.gdx.math.Vector2 b, net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.Body,com.badlogic.gdx.physics.box2d.Body> store)
static boolean	split(com.badlogic.gdx.physics.box2d.Fixture fixture, com.badlogic.gdx.math.Vector2 a, com.badlogic.gdx.math.Vector2 b, com.badlogic.gdx.physics.box2d.Body aBody, com.badlogic.gdx.physics.box2d.Body bBody, net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.Fixture,com.badlogic.gdx.physics.box2d.Fixture> store)
static boolean	split(com.badlogic.gdx.physics.box2d.Fixture fixture, com.badlogic.gdx.math.Vector2 a, com.badlogic.gdx.math.Vector2 b, net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.FixtureDef,com.badlogic.gdx.physics.box2d.FixtureDef> store)
static <T extends com.badlogic.gdx.physics.box2d.Shape> boolean	split(T shape, com.badlogic.gdx.math.Vector2 a, com.badlogic.gdx.math.Vector2 b, net.dermetfan.utils.Pair<T,T> store) splits the given Shape using the segment described by the two given Vector2s
static com.badlogic.gdx.math.Vector2[]	vertices(com.badlogic.gdx.physics.box2d.Body body)
static com.badlogic.gdx.math.Vector2[]	vertices(com.badlogic.gdx.physics.box2d.Fixture fixture)
static com.badlogic.gdx.math.Vector2[]	vertices(com.badlogic.gdx.physics.box2d.Shape shape)
private static com.badlogic.gdx.math.Vector2[]	vertices0(com.badlogic.gdx.physics.box2d.Shape shape)
static float	width(com.badlogic.gdx.physics.box2d.Body body)
static float	width(com.badlogic.gdx.physics.box2d.Fixture fixture)
static float	width(com.badlogic.gdx.physics.box2d.Shape shape)
private static float	width0(com.badlogic.gdx.physics.box2d.Shape shape)

Methods inherited from class java.lang.Object

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

Field Detail

cache

public static final com.badlogic.gdx.utils.ObjectMap<com.badlogic.gdx.physics.box2d.Shape,Box2DUtils.ShapeCache> cache

Cached Shapes and their Box2DUtils.ShapeCache. You should clear this when you don't use the shapes anymore.

autoCache

public static boolean autoCache

if shapes should automatically be cached when they are inspected for the first time

minExclusivePolygonArea

public static final float minExclusivePolygonArea

the area that is too small for a PolygonShape to contain it (limitation by Box2D)

See Also:

Constant Field Values

maxPolygonVertices

public static final byte maxPolygonVertices

the max amount of vertices of a PolygonShape (limitation by Box2D)

See Also:

Constant Field Values

checkPreconditions

public static boolean checkPreconditions

if Box2D preconditions should be checked to avoid crashes

vec2_0

private static final com.badlogic.gdx.math.Vector2 vec2_0

for internal, temporary usage

vec2_1

private static final com.badlogic.gdx.math.Vector2 vec2_1

for internal, temporary usage

Constructor Detail

Box2DUtils

public Box2DUtils()

Method Detail

cache

public static Box2DUtils.ShapeCache cache(com.badlogic.gdx.physics.box2d.Shape shape)

Parameters:

shape - the Shape to create a new Box2DUtils.ShapeCache for that will be added to cache

vertices0

private static com.badlogic.gdx.math.Vector2[] vertices0(com.badlogic.gdx.physics.box2d.Shape shape)

Parameters:

shape - the Shape which vertices to get (for circles, the bounding box vertices will be returned)

Returns:

the vertices of the given Shape

minX0

private static float minX0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the minimal x of the vertices of the given Shape

minY0

private static float minY0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the minimal y of the vertices of the given Shape

maxX0

private static float maxX0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the maximal x of the vertices of the given Shape

maxY0

private static float maxY0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the maximal y of the vertices of the given Shape

width0

private static float width0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the width of the given Shape

height0

private static float height0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the height of the given Shape

size0

private static com.badlogic.gdx.math.Vector2 size0(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

a Vector2 representing the size of the given Shape

vertices

public static com.badlogic.gdx.math.Vector2[] vertices(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the vertices of the given Shape

minX

public static float minX(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the minimal x value of the vertices of the given Shape

minY

public static float minY(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the minimal y value of the vertices of the given Shape

maxX

public static float maxX(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the maximal x value of the vertices of the given Shape

maxY

public static float maxY(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the maximal y value of the vertices of the given Shape

width

public static float width(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the width of the given Shape

height

public static float height(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

the height of the given Shape

size

public static com.badlogic.gdx.math.Vector2 size(com.badlogic.gdx.physics.box2d.Shape shape)

Returns:

a Vector2 representing the size of the given Shape

vertices

public static com.badlogic.gdx.math.Vector2[] vertices(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

vertices(Shape)

minX

public static float minX(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

minX(Shape)

minY

public static float minY(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

minY(Shape)

maxX

public static float maxX(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

maxX(Shape)

maxY

public static float maxY(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

maxY(Shape)

width

public static float width(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

width(Shape)

height

public static float height(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

height(Shape)

size

public static com.badlogic.gdx.math.Vector2 size(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

size(Shape)

fixtureVertices

public static com.badlogic.gdx.math.Vector2[][] fixtureVertices(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the vertices of all fixtures of a body

vertices

public static com.badlogic.gdx.math.Vector2[] vertices(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the vertices of a body's fixtures

minX

public static float minX(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the minimal x value of the vertices of all fixtures of the the given Body

minY

public static float minY(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the minimal y value of the vertices of all fixtures of the the given Body

maxX

public static float maxX(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the maximal x value of the vertices of all fixtures of the the given Body

maxY

public static float maxY(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the maximal y value of the vertices of all fixtures of the the given Body

width

public static float width(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the width of the given Body

height

public static float height(com.badlogic.gdx.physics.box2d.Body body)

Returns:

the height of the given Body

size

public static com.badlogic.gdx.math.Vector2 size(com.badlogic.gdx.physics.box2d.Body body)

positionRelative

public static com.badlogic.gdx.math.Vector2 positionRelative(com.badlogic.gdx.physics.box2d.CircleShape shape)

See Also:

positionRelative(Shape, float), CircleShape.getPosition()

positionRelative

public static com.badlogic.gdx.math.Vector2 positionRelative(com.badlogic.gdx.physics.box2d.Shape shape,
                                                             float rotation)

Returns:

the position of the given shape relatively to its Body

position

public static com.badlogic.gdx.math.Vector2 position(com.badlogic.gdx.physics.box2d.Shape shape,
                                                     com.badlogic.gdx.physics.box2d.Body body)

Parameters:

shape - the Shape which position to get

body - the Body the given Shape is attached to

Returns:

the position of the given Shape in world coordinates

positionRelative

public static com.badlogic.gdx.math.Vector2 positionRelative(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

positionRelative(Shape, float)

position

public static com.badlogic.gdx.math.Vector2 position(com.badlogic.gdx.physics.box2d.Fixture fixture)

See Also:

position(Shape, Body)

clone

public static com.badlogic.gdx.physics.box2d.Body clone(com.badlogic.gdx.physics.box2d.Body body)

clones a Body (without deep copying the Shapes of its Fixtures)

Returns:

copy(body, false)

See Also:

clone(Body, boolean)

clone

public static com.badlogic.gdx.physics.box2d.Body clone(com.badlogic.gdx.physics.box2d.Body body,
                                                        boolean shapes)

clones a Body

Parameters:

body - the Body to copy

shapes - if the Shapes of the Fixures of the given body should be copied as well

Returns:

a deep copy of the given body

clone

public static com.badlogic.gdx.physics.box2d.Fixture clone(com.badlogic.gdx.physics.box2d.Fixture fixture,
                                                           com.badlogic.gdx.physics.box2d.Body body)

clones a Fixture (without deep copying its Shape)

Returns:

copy(fixture, body, false)

See Also:

clone(Fixture, Body, boolean)

clone

public static com.badlogic.gdx.physics.box2d.Fixture clone(com.badlogic.gdx.physics.box2d.Fixture fixture,
                                                           com.badlogic.gdx.physics.box2d.Body body,
                                                           boolean shape)

clones a Fixture

Parameters:

fixture - the Fixture to copy

body - the Body to create a copy of the given fixture on

shape - if the shape of the given fixture should be deep copied as well

Returns:

the copied Fixture

clone

public static <T extends com.badlogic.gdx.physics.box2d.Shape> T clone(T shape)

creates a deep copy of a Shape
Note: The previous and next vertex of a ChainShape will not be copied since this is not possible due to the API.

Parameters:

shape - the Shape to copy

Returns:

a Shape exactly like the one passed in

createDef

public static com.badlogic.gdx.physics.box2d.BodyDef createDef(com.badlogic.gdx.physics.box2d.Body body)

Parameters:

body - the body for which to setup a new BodyDef

Returns:

a new BodyDef instance that can be used to clone the given body

createDef

public static com.badlogic.gdx.physics.box2d.FixtureDef createDef(com.badlogic.gdx.physics.box2d.Fixture fixture)

Parameters:

fixture - the fixture for which to setup a new FixtureDef

Returns:

a new FixtureDef instance that can be used to clone the given fixture

split

public static boolean split(com.badlogic.gdx.physics.box2d.Body body,
                            com.badlogic.gdx.math.Vector2 a,
                            com.badlogic.gdx.math.Vector2 b,
                            net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.Body,com.badlogic.gdx.physics.box2d.Body> store)

Parameters:

body - the Body to split

a - the first point of the segment

b - the second point of the segment

store - The Pair to store the resulting bodies in. May be null.

Returns:

If the body was successfully split, which means that all fixtures intersecting with the given segment were split. If false, only some fixtures may have been created!

split

public static boolean split(com.badlogic.gdx.physics.box2d.Fixture fixture,
                            com.badlogic.gdx.math.Vector2 a,
                            com.badlogic.gdx.math.Vector2 b,
                            com.badlogic.gdx.physics.box2d.Body aBody,
                            com.badlogic.gdx.physics.box2d.Body bBody,
                            net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.Fixture,com.badlogic.gdx.physics.box2d.Fixture> store)

Parameters:

fixture - the fixture to split

a - the first point of the segment

b - the second point of the segment

aBody - the body the first resulting fixture will be created on

bBody - the body the second resulting fixture will be created on

store - The Pair to store the resulting fixtures in. May be null.

Returns:

if the fixture was split

See Also:

split(Shape, Vector2, Vector2, Pair)

split

public static boolean split(com.badlogic.gdx.physics.box2d.Fixture fixture,
                            com.badlogic.gdx.math.Vector2 a,
                            com.badlogic.gdx.math.Vector2 b,
                            net.dermetfan.utils.Pair<com.badlogic.gdx.physics.box2d.FixtureDef,com.badlogic.gdx.physics.box2d.FixtureDef> store)

Parameters:

fixture - the fixture to split

a - the first point of the segment

b - the second point of the segment

store - the Pair to store the resulting FixtureDefs in

Returns:

if the fixture was split

See Also:

split(Shape, Vector2, Vector2, Pair)

split

public static <T extends com.badlogic.gdx.physics.box2d.Shape> boolean split(T shape,
                                                                             com.badlogic.gdx.math.Vector2 a,
                                                                             com.badlogic.gdx.math.Vector2 b,
                                                                             net.dermetfan.utils.Pair<T,T> store)

splits the given Shape using the segment described by the two given Vector2s

Parameters:

shape - the Shape to split

a - the first point of the segment

b - the second point of the segment

store - the Pair to store the split Shapes in

Returns:

if the given shape was split

setSensor

public static void setSensor(com.badlogic.gdx.physics.box2d.Body body,
                             boolean sensor)

sets the sensor flag of all of the given Body's Fixtures

Parameters:

body - the Body which Fixtures' sensor flag to set

sensor - the parameter to pass to Fixture.setSensor(boolean)

See Also:

Fixture.setSensor(boolean)

destroyFixtures

public static void destroyFixtures(com.badlogic.gdx.physics.box2d.Body body)

destroys all fixtures of the given body

Parameters:

body - the body which fixtures to destroy

destroyFixtures

public static void destroyFixtures(com.badlogic.gdx.physics.box2d.Body body,
                                   com.badlogic.gdx.utils.Array<com.badlogic.gdx.physics.box2d.Fixture> exclude)

destroys all fixtures of the given body except the given ones

Parameters:

exclude - the fixtures not to destroy

body - the body which fixtures to destroy

destroyFixtures

public static void destroyFixtures(com.badlogic.gdx.physics.box2d.Body body,
                                   com.badlogic.gdx.physics.box2d.Fixture... exclude)

See Also:

destroyFixtures(Body, Array)

destroyFixtures

public static void destroyFixtures(com.badlogic.gdx.physics.box2d.Body body,
                                   com.badlogic.gdx.physics.box2d.Fixture exclude)

See Also:

destroyFixtures(Body, Array)