Class Circle

collider - circle

Hierarchy (view full)

SATCircle
- Circle

Implements

Index

Constructors

constructor

Properties

angle bbox dirty isCentered isConvex isStatic isTrigger maxX maxY minX minY offset offsetCopy padding pos r system? type unscaledRadius

Accessors

scale scaleX scaleY x y

Methods

draw drawBVH getAABBAsBBox getOffsetWithAngle markAsDirty setAngle setOffset setPosition setScale updateBody

Constructors

constructor

new Circle(position, radius, options?): Circle
collider - circle
Parameters
- position: PotentialVector
- radius: number
- Optional options: BodyOptions
Returns Circle
Overrides SATCircle.constructor
- Defined in src/bodies/circle.ts:108

Properties

angle

angle: number

for compatibility reasons circle has angle

bbox

bbox: BBox

bounding box cache, without padding

dirty

dirty: boolean = false

was the polygon modified and needs update in the next checkCollision

`Readonly` isCentered

isCentered: true = true

always centered

`Readonly` isConvex

isConvex: true = true

flag to show is it a convex body or non convex polygon

isStatic

isStatic: boolean

static bodies don't move but they collide

isTrigger

isTrigger: boolean

trigger bodies move but are like ghosts

maxX

maxX: number

maximum x bound of body

maxY

maxY: number

maximum y bound of body

minX

minX: number

minimum x bound of body

minY

minY: number

minimum y bound of body

offset

offset: SATVector

offset

offsetCopy

offsetCopy: Vector = ...

offset copy without angle applied

padding

padding: number

bodies are not reinserted during update if their bbox didnt move outside bbox + padding

pos

pos: SATVector

r

r: number

`Optional` system

system?: BaseSystem<Body>

reference to collision system

`Readonly` type

type: Circle = BodyType.Circle

circle type

`Protected` `Readonly` unscaledRadius

unscaledRadius: number

saved initial radius - internal

Accessors

scale

get scale(): number
allow get scale

Returns number
- Defined in src/bodies/circle.ts:153
set scale(scale): void
shorthand for setScale()
Parameters
- scale: number
Returns void
- Defined in src/bodies/circle.ts:160

scaleX

get scaleX(): number
scaleX = scale in case of Circles

Returns number
Implementation of BodyProps.scaleX
- Defined in src/bodies/circle.ts:167

scaleY

get scaleY(): number
scaleY = scale in case of Circles

Returns number
Implementation of BodyProps.scaleY
- Defined in src/bodies/circle.ts:174

x

get x(): number
get this.pos.x

Returns number
- Defined in src/bodies/circle.ts:123
set x(x): void
updating this.pos.x by this.x = x updates AABB
Parameters
- x: number
Returns void
- Defined in src/bodies/circle.ts:130

y

get y(): number
get this.pos.y

Returns number
- Defined in src/bodies/circle.ts:138
set y(y): void
updating this.pos.y by this.y = y updates AABB
Parameters
- y: number
Returns void
- Defined in src/bodies/circle.ts:145

Methods

draw

draw(context): void
Draws collider on a CanvasRenderingContext2D's current path
Parameters
- context: CanvasRenderingContext2D
Returns void
Implementation of BodyProps.draw
- Defined in src/bodies/circle.ts:246

drawBVH

drawBVH(context): void
Draws Bounding Box on canvas context
Parameters
- context: CanvasRenderingContext2D
Returns void
Implementation of BodyProps.drawBVH
- Defined in src/bodies/circle.ts:273

getAABBAsBBox

getAABBAsBBox(): BBox
get body bounding box, without padding

Returns BBox
Implementation of BodyProps.getAABBAsBBox
- Defined in src/bodies/circle.ts:231

`Protected` getOffsetWithAngle

getOffsetWithAngle(): Vector
internal for getting offset with applied angle

Returns Vector
- Defined in src/bodies/circle.ts:301

`Protected` markAsDirty

markAsDirty(update?): void
update instantly or mark as dirty
Parameters
- update: boolean = false
Returns void
- Defined in src/bodies/circle.ts:290

setAngle

setAngle(angle, update?): Circle
set rotation
Parameters
- angle: number
- update: boolean = true
Returns Circle
Implementation of BodyProps.setAngle
- Defined in src/bodies/circle.ts:202

setOffset

setOffset(offset, update?): Circle
set offset from center
Parameters
- offset: Vector
- update: boolean = true
Returns Circle
Implementation of BodyProps.setOffset
- Defined in src/bodies/circle.ts:216

setPosition

setPosition(x, y, update?): Circle
update position
Parameters
- x: number
- y: number
- update: boolean = true
Returns Circle
Implementation of BodyProps.setPosition
- Defined in src/bodies/circle.ts:181

setScale

setScale(scaleX, _scaleY?, update?): Circle
update scale
Parameters
- scaleX: number
- _scaleY: number = scaleX
- update: boolean = true
Returns Circle
Implementation of BodyProps.setScale
- Defined in src/bodies/circle.ts:192

updateBody

updateBody(update?): void
inner function for after position change update aabb in system
Parameters
- update: boolean = ...
Returns void
- Defined in src/bodies/circle.ts:280

Class Circle

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Circle

Properties

angle

bbox

dirty

Readonly isCentered

Readonly isConvex

isStatic

isTrigger

maxX

maxY

minX

minY

offset

offsetCopy

padding

pos

r

Optional system

Readonly type

Protected Readonly unscaledRadius

Accessors

scale

Returns number

Parameters

Returns void

scaleX

Returns number

scaleY

Returns number

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

draw

Parameters

Returns void

drawBVH

Parameters

Returns void

getAABBAsBBox

Returns BBox

Protected getOffsetWithAngle

Returns Vector

Protected markAsDirty

Parameters

Returns void

setAngle

Parameters

Returns Circle

setOffset

Parameters

Returns Circle

setPosition

Parameters

Returns Circle

setScale

Parameters

Returns Circle

updateBody

Parameters

Returns void

Settings

Member Visibility

`Readonly` isCentered

`Readonly` isConvex

`Optional` system

`Readonly` type

`Protected` `Readonly` unscaledRadius

`Protected` getOffsetWithAngle

`Protected` markAsDirty