Debug

Index

Constructors

• constructor

Properties

• _ctx
• _drawCalls
• z

Methods

• clear
• draw
• drawBounds
• drawCircle
• drawLine
• drawLines
• drawPoint
• drawPolygon
• drawRay
• drawText
• flush
• registerGraphicsContext

Constructors

constructor

• new Debug(): Debug

• Returns Debug

Properties

static_ctx

_ctx: ExcaliburGraphicsContext

static_drawCalls

_drawCalls: (ctx: ExcaliburGraphicsContext) => void[] = []

staticz

z: number = Infinity

Methods

staticclear

• clear(): void

• Returns void

staticdraw

• draw(debugDrawCall: (ctx: ExcaliburGraphicsContext) => void): void

• Parameters

  • debugDrawCall: (ctx: ExcaliburGraphicsContext) => void

  Returns void

staticdrawBounds

• drawBounds(boundingBox: BoundingBox, options?: { color?: Color }): void

• Parameters

  • boundingBox: BoundingBox

  • optionaloptions: { color?: Color }

  • optionalcolor: Color

  Returns void

staticdrawCircle

• drawCircle(center: Vector, radius: number, options?: { color?: Color; strokeColor?: Color; width?: number }): void

• Parameters

  • center: Vector

  • radius: number

  • optionaloptions: { color?: Color; strokeColor?: Color; width?: number }

  • optionalcolor: Color

  • optionalstrokeColor: Color

  • optionalwidth: number

  Returns void

staticdrawLine

• drawLine(start: Vector, end: Vector, options?: LineGraphicsOptions): void

• Parameters

  • start: Vector

  • end: Vector

  • optionaloptions: LineGraphicsOptions

  Returns void

staticdrawLines

• drawLines(points: Vector[], options?: LineGraphicsOptions): void

• Parameters

  • points: Vector[]

  • optionaloptions: LineGraphicsOptions

  Returns void

staticdrawPoint

• drawPoint(point: Vector, options?: PointGraphicsOptions): void

• Parameters

  • point: Vector

  • optionaloptions: PointGraphicsOptions

  Returns void

staticdrawPolygon

• drawPolygon(points: Vector[], options?: { color?: Color }): void

• Parameters

  • points: Vector[]

  • optionaloptions: { color?: Color }

  • optionalcolor: Color

  Returns void

staticdrawRay

• drawRay(ray: Ray, options?: { color?: Color; distance?: number }): void

• Parameters

  • ray: Ray

  • optionaloptions: { color?: Color; distance?: number }

  • optionalcolor: Color

  • optionaldistance: number

  Returns void

staticdrawText

• drawText(text: string, pos: Vector): void

• Parameters

  • text: string

  • pos: Vector

  Returns void

staticflush

• flush(ctx: ExcaliburGraphicsContext): void

• Parameters

  • ctx: ExcaliburGraphicsContext

  Returns void

staticregisterGraphicsContext

• registerGraphicsContext(ctx: ExcaliburGraphicsContext): void

• Parameters

  • ctx: ExcaliburGraphicsContext

  Returns void