Class CircleBody

Hierarchy

  • Ellipse
    • CircleBody

Implements

Constructors

constructor

Properties

_group _radiusX _radiusY _step angle bbox calcPoints centered convexPolygons destroy$ dirty edges gameObject isConvex isStatic isTrigger label maxX maxY minX minY normals offset padding points pointsBackup pos scaleVector system? type typeGroup update$ userData?

Accessors

group isCentered radiusX radiusY scale scaleX scaleY step x y

Methods

center destroy draw drawBVH getAABB getAABBAsBBox getCentroid getCentroidWithoutRotation getConvex isSimple markAsDirty move retranslate rotate setAngle setOffset setPoints setPosition setScale translate update updateBody updateConvexPolygonPositions updateConvexPolygons updateIsConvex

Constructors

constructor

  • new CircleBody(gameObject, radiusX, radiusY?, step?, options?): CircleBody

  • Parameters

    • gameObject: GameObject
    • radiusX: number
    • radiusY: number = radiusX
    • step: number = 16
    • Optionaloptions: BodyOptions<any>

    Returns CircleBody

Properties

Protected_group

_group: number

group for collision filtering

Protected_radiusX

_radiusX: number

inner initial params save

Protected_radiusY

_radiusY: number

Protected_step

_step: number

angle

angle: number

bbox

bbox: BBox

bounding box cache, without padding

calcPoints

calcPoints: Vector[]

Protectedcentered

centered: boolean

is body centered

convexPolygons

convexPolygons: Polygon[]

optimization for convex polygons

Readonlydestroy$

destroy$: Subject<void> = ...

When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.

dirty

dirty: boolean

was the polygon modified and needs update in the next checkCollision

edges

edges: Vector[]

gameObject

gameObject: LifecycleParent

Parent GameObject is assigned at creation.

ReadonlyisConvex

isConvex = true

ellipses are convex

isStatic

isStatic: boolean

static bodies don't move but they collide

isTrigger

isTrigger: boolean

trigger bodies move but are like ghosts

label

label: string = 'CircleBody'

Each Lifecycle Object has label for pixi debugging.

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

normals

normals: Vector[]

offset

offset: Vector

padding

padding: number

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

points

points: Vector[]

ProtectedpointsBackup

pointsBackup: Vector[]

backup of points used for scaling

pos

pos: Vector

Protected ReadonlyscaleVector

scaleVector: Vector

scale Vector of body

Optionalsystem

system?: System<Body>

reference to collision system

Readonlytype

type: Ellipse

ellipse type

ReadonlytypeGroup

typeGroup: Ellipse

faster than type

Readonlyupdate$

update$: Subject<number> = ...

When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.

OptionaluserData

userData?: any

allows the user to set any misc data for client use

Accessors

group

  • get group(): number

  • group for collision filtering

    Based on Box2D (tutorial)

    Values in BodyGroup are predefined and used each the body type and should not be used for custom filtering

    0b00000001 << 16 to 0b01000000 << 16 (max 0x7fffffff) are free to use for custom groups

    Returns number

    See

    canInteract for how groups are used

    Default 

    0x7fffffff // member of all groups (can interact with everyting)
  • set group(group): void

  • group for collision filtering

    Based on Box2D (tutorial)

    Values in BodyGroup are predefined and used each the body type and should not be used for custom filtering

    0b00000001 << 16 to 0b01000000 << 16 (max 0x7fffffff) are free to use for custom groups

    Parameters

    • group: number

    Returns void

    See

    canInteract for how groups are used

    Default 

    0x7fffffff // member of all groups (can interact with everyting)

isCentered

  • get isCentered(): boolean

  • is body centered?

    Returns boolean

  • set isCentered(_isCentered): void

  • flag to set is body centered

    Parameters

    • _isCentered: boolean

    Returns void

radiusX

  • get radiusX(): number

  • get ellipse radiusX

    Returns number

  • set radiusX(radiusX): void

  • set ellipse radiusX, update points

    Parameters

    • radiusX: number

    Returns void

radiusY

  • get radiusY(): number

  • get ellipse radiusY

    Returns number

  • set radiusY(radiusY): void

  • set ellipse radiusY, update points

    Parameters

    • radiusY: number

    Returns void

scale

  • get scale(): number

  • allow approx getting of scale

    Returns number

  • set scale(scale): void

  • allow easier setting of scale

    Parameters

    • scale: number

    Returns void

scaleX

  • get scaleX(): number

  • allow exact getting of scale x - use setScale(x, y) to set

    Returns number

scaleY

  • get scaleY(): number

  • allow exact getting of scale y - use setScale(x, y) to set

    Returns number

step

  • get step(): number

  • get ellipse step number

    Returns number

  • set step(step): void

  • set ellipse step number

    Parameters

    • step: number

    Returns void

x

  • get x(): number

  • Returns number

  • set x(x): void

  • updating this.pos.x by this.x = x updates AABB

    Parameters

    • x: number

    Returns void

y

  • get y(): number

  • Returns number

  • set y(y): void

  • updating this.pos.y by this.y = y updates AABB

    Parameters

    • y: number

    Returns void

Methods

center

  • center(): void

  • do not attempt to use Polygon.center()

    Returns void

destroy

draw

  • draw(context): void

  • Draws exact collider on canvas context

    Parameters

    • context: CanvasRenderingContext2D

    Returns void

drawBVH

  • drawBVH(context): void

  • Draws Bounding Box on canvas context

    Parameters

    • context: CanvasRenderingContext2D

    Returns void

getAABB

  • getAABB(): Polygon

  • Returns Polygon

getAABBAsBBox

  • getAABBAsBBox(): BBox

  • get body bounding box, without padding

    Returns BBox

getCentroid

  • getCentroid(): Vector

  • Returns Vector

getCentroidWithoutRotation

  • getCentroidWithoutRotation(): Vector

  • get body centroid without applied angle

    Returns Vector

ProtectedgetConvex

  • getConvex(): Polygon[]

  • returns body split into convex polygons, or empty array for convex bodies

    Returns Polygon[]

isSimple

  • isSimple(): boolean

  • if true, polygon is not an invalid, self-crossing polygon

    Returns boolean

ProtectedmarkAsDirty

  • markAsDirty(updateNow?): void

  • update instantly or mark as dirty

    Parameters

    • OptionalupdateNow: boolean

    Returns void

move

  • move(speed?, updateNow?): Polygon

  • update position BY MOVING FORWARD IN ANGLE DIRECTION

    Parameters

    • Optionalspeed: number
    • OptionalupdateNow: boolean

    Returns Polygon

Protectedretranslate

  • retranslate(isCentered?): void

  • Parameters

    • OptionalisCentered: boolean

    Returns void

rotate

  • rotate(angle): Polygon<any>

  • rotates polygon points by angle, in radians

    Parameters

    • angle: number

    Returns Polygon<any>

setAngle

  • setAngle(angle, updateNow?): Polygon

  • Parameters

    • angle: number
    • OptionalupdateNow: boolean

    Returns Polygon

setOffset

  • setOffset(offset, updateNow?): Polygon

  • Parameters

    • offset: Vector
    • OptionalupdateNow: boolean

    Returns Polygon

setPoints

  • setPoints(points): Polygon<any>

  • sets polygon points to new array of vectors

    Parameters

    • points: Vector[]

    Returns Polygon<any>

setPosition

  • setPosition(x, y, updateNow?): Polygon

  • update position BY TELEPORTING

    Parameters

    • x: number
    • y: number
    • OptionalupdateNow: boolean

    Returns Polygon

setScale

  • setScale(x, y?, updateNow?): Polygon

  • update scale

    Parameters

    • x: number
    • Optionaly: number
    • OptionalupdateNow: boolean

    Returns Polygon

translate

  • translate(x, y): Polygon<any>

  • translates polygon points in x, y direction

    Parameters

    • x: number
    • y: number

    Returns Polygon<any>

update

updateBody

  • updateBody(updateNow?): void

  • inner function for after position change update aabb in system and convex inner polygons

    Parameters

    • OptionalupdateNow: boolean

    Returns void

ProtectedupdateConvexPolygonPositions

  • updateConvexPolygonPositions(): void

  • update the position of the decomposed convex polygons (if any), called after the position of the body has changed

    Returns void

ProtectedupdateConvexPolygons

  • updateConvexPolygons(convex?): void

  • updates convex polygons cache in body

    Parameters

    • Optionalconvex: Polygon[]

    Returns void

ProtectedupdateIsConvex

  • updateIsConvex(): void

  • do not attempt to use Polygon.updateIsConvex()

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods