Class b2DebugDraw

Implement and register this class with a b2World to provide debug drawing of physics entities in your game.

Example

Although Box2D is a physics engine and therefore has nothing to do with drawing, Box2dFlash provides such methods for debugging which are defined in the b2DebugDraw class. In Box2dWeb, a b2DebugDraw takes a canvas-context instead of a Sprite:

	var debugDraw = new Box2D.Dynamics.b2DebugDraw();
	debugDraw.SetSprite(document.GetElementsByTagName("canvas")[0].getContext("2d"));

Constructors

constructor

Properties

e_aabbBit e_centerOfMassBit e_controllerBit e_jointBit e_pairBit e_shapeBit

Methods

AppendFlags ClearFlags DrawCircle DrawPolygon DrawSegment DrawSolidCircle DrawSolidPolygon DrawTransform GetAlpha GetDrawScale GetFillAlpha GetFlags GetLineThickness GetSprite GetXFormScale SetAlpha SetDrawScale SetFillAlpha SetFlags SetLineThickness SetSprite SetXFormScale

Constructors

constructor

Properties

Statice_aabbBit

e_aabbBit: number

Draw axis aligned bounding boxes.

Statice_centerOfMassBit

e_centerOfMassBit: number

Draw center of mass frame.

Statice_controllerBit

e_controllerBit: number

Draw controllers.

Statice_jointBit

e_jointBit: number

Draw joint connections.

Statice_pairBit

e_pairBit: number

Draw broad-phase pairs.

Statice_shapeBit

e_shapeBit: number

Draw shapes.

Methods

AppendFlags

  • AppendFlags(flags: number): void

  • Append flags to the current flags.

    Parameters

    • flags: number

      Flags to add.

    Returns void

ClearFlags

  • ClearFlags(flags: number): void

  • Clear flags from the current flags.

    Parameters

    • flags: number

      flags to clear.

    Returns void

DrawCircle

DrawPolygon

  • DrawPolygon(vertices: b2Vec2[], vertexCount: number, color: b2Color): void

  • Draw a closed polygon provided in CCW order.

    Parameters

    • vertices: b2Vec2[]

      Polygon verticies.

    • vertexCount: number

      Number of vertices in the polygon, usually vertices.length.

    • color: b2Color

      Polygon draw color.

    Returns void

DrawSegment

DrawSolidCircle

DrawSolidPolygon

  • DrawSolidPolygon(vertices: b2Vec2[], vertexCount: number, color: b2Color): void

  • Draw a solid closed polygon provided in CCW order.

    Parameters

    • vertices: b2Vec2[]

      Polygon verticies.

    • vertexCount: number

      Number of vertices in the polygon, usually vertices.length.

    • color: b2Color

      Polygon draw color.

    Returns void

DrawTransform

GetAlpha

  • GetAlpha(): number

  • Get the alpha value used for lines.

    Returns number

    Alpha value used for drawing lines.

GetDrawScale

GetFillAlpha

  • GetFillAlpha(): number

  • Get the alpha value used for fills.

    Returns number

    Alpha value used for drawing fills.

GetFlags

GetLineThickness

GetSprite

  • GetSprite(): CanvasRenderingContext2D

  • Get the HTML Canvas Element for drawing.

    Returns CanvasRenderingContext2D

    The HTML Canvas Element used for debug drawing.

    Note

    box2dflash uses Sprite object, box2dweb uses CanvasRenderingContext2D, that is why this function is called GetSprite().

GetXFormScale

  • GetXFormScale(): number

  • Get the scale used for drawing XForms.

    Returns number

    Scale for drawing transforms.

SetAlpha

  • SetAlpha(alpha: number): void

  • Set the alpha value used for lines.

    Parameters

    • alpha: number

      Alpha value for drawing lines.

    Returns void

SetDrawScale

  • SetDrawScale(drawScale: number): void

  • Set the draw scale.

    Parameters

    • drawScale: number

      Draw scale ratio.

    Returns void

SetFillAlpha

  • SetFillAlpha(alpha: number): void

  • Set the alpha value used for fills.

    Parameters

    • alpha: number

      Alpha value for drawing fills.

    Returns void

SetFlags

  • SetFlags(flags: number): void

  • Set the drawing flags.

    Parameters

    • flags: number

      Sets the drawing flags.

    Returns void

SetLineThickness

  • SetLineThickness(lineThickness: number): void

  • Set the line thickness.

    Parameters

    • lineThickness: number

      The new line thickness.

    Returns void

SetSprite

  • SetSprite(canvas: CanvasRenderingContext2D): void

  • Set the HTML Canvas Element for drawing.

    Parameters

    • canvas: CanvasRenderingContext2D

      HTML Canvas Element to draw debug information to.

    Returns void

    Note

    box2dflash uses Sprite object, box2dweb uses CanvasRenderingContext2D, that is why this function is called SetSprite().

SetXFormScale

  • SetXFormScale(xformScale: number): void

  • Set the scale used for drawing XForms.

    Parameters

    • xformScale: number

      The transform scale.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods