com.almasb.fxgl.physics.box2d.callbacks

Class DebugDraw

java.lang.Object

com.almasb.fxgl.physics.box2d.callbacks.DebugDraw

public abstract class DebugDraw
extends Object

Implement this abstract class to allow JBox2d to automatically draw your physics for debugging purposes. Not intended to replace your own custom rendering routines!

Author:

Daniel Murphy

Field Summary

Fields

Modifier and Type	Field and Description
static int	e_aabbBit Draw axis aligned bounding boxes
static int	e_centerOfMassBit Draw center of mass frame
static int	e_dynamicTreeBit Draw dynamic tree
static int	e_jointBit Draw joint connections
static int	e_pairBit Draw pairs of connected objects
static int	e_shapeBit Draw shapes
static int	e_wireframeDrawingBit Draw only the wireframe for drawing performance
protected int	m_drawFlags
protected IViewportTransform	viewportTransform

Constructor Summary

Constructors

Constructor and Description
DebugDraw()
DebugDraw(IViewportTransform viewport)

Method Summary

Modifier and Type	Method and Description
void	appendFlags(int flags)
void	clearFlags(int flags)
abstract void	drawCircle(Vec2 center, float radius, javafx.scene.paint.Color color) Draw a circle.
void	drawCircle(Vec2 center, float radius, Vec2 axis, javafx.scene.paint.Color color) Draws a circle with an axis
abstract void	drawParticles(Vec2[] centers, float radius, ParticleColor[] colors, int count) Draw a particle array
abstract void	drawParticlesWireframe(Vec2[] centers, float radius, ParticleColor[] colors, int count) Draw a particle array
abstract void	drawPoint(Vec2 argPoint, float argRadiusOnScreen, javafx.scene.paint.Color argColor)
void	drawPolygon(Vec2[] vertices, int vertexCount, javafx.scene.paint.Color color) Draw a closed polygon provided in CCW order.
abstract void	drawSegment(Vec2 p1, Vec2 p2, javafx.scene.paint.Color color) Draw a line segment.
abstract void	drawSolidCircle(Vec2 center, float radius, Vec2 axis, javafx.scene.paint.Color color) Draw a solid circle.
abstract void	drawSolidPolygon(Vec2[] vertices, int vertexCount, javafx.scene.paint.Color color) Draw a solid closed polygon provided in CCW order.
abstract void	drawString(float x, float y, String s, javafx.scene.paint.Color color) Draw a string.
void	drawString(Vec2 pos, String s, javafx.scene.paint.Color color)
abstract void	drawTransform(Transform xf) Draw a transform.
void	flush() Called at the end of drawing a world
int	getFlags()
Vec2	getScreenToWorld(float screenX, float screenY) takes the screen coordinates and returns the world coordinates.
Vec2	getScreenToWorld(Vec2 argScreen) takes the screen coordinates (argScreen) and returns the world coordinates
void	getScreenToWorldToOut(float screenX, float screenY, Vec2 argWorld) takes the screen coordinates and puts the corresponding world coordinates in argWorld.
void	getScreenToWorldToOut(Vec2 argScreen, Vec2 argWorld)
IViewportTransform	getViewportTranform()
Vec2	getWorldToScreen(float worldX, float worldY) Takes the world coordinates and returns the screen coordinates.
Vec2	getWorldToScreen(Vec2 argWorld) takes the world coordinate (argWorld) and returns the screen coordinates.
void	getWorldToScreenToOut(float worldX, float worldY, Vec2 argScreen) Takes the world coordinates and puts the corresponding screen coordinates in argScreen.
void	getWorldToScreenToOut(Vec2 argWorld, Vec2 argScreen)
void	setCamera(float x, float y, float scale) Deprecated. use the viewport transform in getViewportTranform()
void	setFlags(int flags)
void	setViewportTransform(IViewportTransform viewportTransform)

Methods inherited from class java.lang.Object

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

Field Detail

e_shapeBit

public static final int e_shapeBit

Draw shapes

See Also:

Constant Field Values

e_jointBit

public static final int e_jointBit

Draw joint connections

See Also:

Constant Field Values

e_aabbBit

public static final int e_aabbBit

Draw axis aligned bounding boxes

See Also:

Constant Field Values

e_pairBit

public static final int e_pairBit

Draw pairs of connected objects

See Also:

Constant Field Values

e_centerOfMassBit

public static final int e_centerOfMassBit

Draw center of mass frame

See Also:

Constant Field Values

e_dynamicTreeBit

public static final int e_dynamicTreeBit

Draw dynamic tree

See Also:

Constant Field Values

e_wireframeDrawingBit

public static final int e_wireframeDrawingBit

Draw only the wireframe for drawing performance

See Also:

Constant Field Values

m_drawFlags

protected int m_drawFlags

viewportTransform

protected IViewportTransform viewportTransform

Constructor Detail

DebugDraw

public DebugDraw()

DebugDraw

public DebugDraw(IViewportTransform viewport)

Method Detail

setViewportTransform

public void setViewportTransform(IViewportTransform viewportTransform)

setFlags

public void setFlags(int flags)

getFlags

public int getFlags()

appendFlags

public void appendFlags(int flags)

clearFlags

public void clearFlags(int flags)

drawPolygon

public void drawPolygon(Vec2[] vertices,
                        int vertexCount,
                        javafx.scene.paint.Color color)

Draw a closed polygon provided in CCW order. This implementation uses drawSegment(Vec2, Vec2, Color) to draw each side of the polygon.

Parameters:

vertices -

vertexCount -

color -

drawPoint

public abstract void drawPoint(Vec2 argPoint,
                               float argRadiusOnScreen,
                               javafx.scene.paint.Color argColor)

drawSolidPolygon

public abstract void drawSolidPolygon(Vec2[] vertices,
                                      int vertexCount,
                                      javafx.scene.paint.Color color)

Draw a solid closed polygon provided in CCW order.

Parameters:

vertices -

vertexCount -

color -

drawCircle

public abstract void drawCircle(Vec2 center,
                                float radius,
                                javafx.scene.paint.Color color)

Draw a circle.

Parameters:

center -

radius -

color -

drawCircle

public void drawCircle(Vec2 center,
                       float radius,
                       Vec2 axis,
                       javafx.scene.paint.Color color)

Draws a circle with an axis

drawSolidCircle

public abstract void drawSolidCircle(Vec2 center,
                                     float radius,
                                     Vec2 axis,
                                     javafx.scene.paint.Color color)

Draw a solid circle.

Parameters:

center -

radius -

axis -

color -

drawSegment

public abstract void drawSegment(Vec2 p1,
                                 Vec2 p2,
                                 javafx.scene.paint.Color color)

Draw a line segment.

Parameters:

p1 -

p2 -

color -

drawTransform

public abstract void drawTransform(Transform xf)

Draw a transform. Choose your own length scale

Parameters:

xf -

drawString

public abstract void drawString(float x,
                                float y,
                                String s,
                                javafx.scene.paint.Color color)

Draw a string.

Parameters:

x -

y -

s -

color -

drawParticles

public abstract void drawParticles(Vec2[] centers,
                                   float radius,
                                   ParticleColor[] colors,
                                   int count)

Draw a particle array

Parameters:

colors - can be null

drawParticlesWireframe

public abstract void drawParticlesWireframe(Vec2[] centers,
                                            float radius,
                                            ParticleColor[] colors,
                                            int count)

Draw a particle array

Parameters:

colors - can be null

flush

public void flush()

Called at the end of drawing a world

drawString

public void drawString(Vec2 pos,
                       String s,
                       javafx.scene.paint.Color color)

getViewportTranform

public IViewportTransform getViewportTranform()

setCamera

public void setCamera(float x,
                      float y,
                      float scale)

Deprecated. use the viewport transform in getViewportTranform()

Parameters:

x -

y -

scale -

getScreenToWorldToOut

public void getScreenToWorldToOut(Vec2 argScreen,
                                  Vec2 argWorld)

Parameters:

argScreen -

argWorld -

getWorldToScreenToOut

public void getWorldToScreenToOut(Vec2 argWorld,
                                  Vec2 argScreen)

Parameters:

argWorld -

argScreen -

getWorldToScreenToOut

public void getWorldToScreenToOut(float worldX,
                                  float worldY,
                                  Vec2 argScreen)

Takes the world coordinates and puts the corresponding screen coordinates in argScreen.

Parameters:

worldX -

worldY -

argScreen -

getWorldToScreen

public Vec2 getWorldToScreen(Vec2 argWorld)

takes the world coordinate (argWorld) and returns the screen coordinates.

Parameters:

argWorld -

getWorldToScreen

public Vec2 getWorldToScreen(float worldX,
                             float worldY)

Takes the world coordinates and returns the screen coordinates.

Parameters:

worldX -

worldY -

getScreenToWorldToOut

public void getScreenToWorldToOut(float screenX,
                                  float screenY,
                                  Vec2 argWorld)

takes the screen coordinates and puts the corresponding world coordinates in argWorld.

Parameters:

screenX -

screenY -

argWorld -

getScreenToWorld

public Vec2 getScreenToWorld(Vec2 argScreen)

takes the screen coordinates (argScreen) and returns the world coordinates

Parameters:

argScreen -

getScreenToWorld

public Vec2 getScreenToWorld(float screenX,
                             float screenY)

takes the screen coordinates and returns the world coordinates.

Parameters:

screenX -

screenY -