Interface BodyProps<UserDataType>

each body contains those regardless of type

interface BodyProps<UserDataType> {
    angle?: number;
    bbox: BBox;
    dirty: boolean;
    group?: number;
    isCentered?: boolean;
    isConvex: boolean;
    isStatic?: boolean;
    isTrigger?: boolean;
    offset: SATVector;
    padding?: number;
    system?: System<Body>;
    type: BodyType;
    typeGroup: BodyGroup;
    userData?: UserDataType;
    get scaleX(): number;
    get scaleY(): number;
    draw(context: CanvasRenderingContext2D): void;
    drawBVH(context: CanvasRenderingContext2D): void;
    getAABBAsBBox(): BBox;
    move(speed: number, updateNow?: boolean): SATPolygon | Circle<any>;
    setAngle(angle: number, updateNow?: boolean): SATPolygon | Circle<any>;
    setOffset(offset: Vector, updateNow?: boolean): SATPolygon | Circle<any>;
    setPosition(x: number, y: number, updateNow?: boolean): SATPolygon | Circle<any>;
    setScale(x: number, y: number, updateNow?: boolean): SATPolygon | Circle<any>;
}

Type Parameters

  • UserDataType = any

Hierarchy (view full)

Implemented by

Properties

angle? bbox dirty group? isCentered? isConvex isStatic? isTrigger? offset padding? system? type typeGroup userData?

Accessors

scaleX scaleY

Methods

draw drawBVH getAABBAsBBox move setAngle setOffset setPosition setScale

Properties

Optionalangle

angle?: number

body angle in radians use deg2rad to convert move(speed) moves at 1 speed = 1px towards angle

bbox

bbox: BBox

bounding box cache, without padding

dirty

dirty: boolean

was the body modified and needs update in the next checkCollision

Optionalgroup

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

See

canInteract for how groups are used

Default

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

OptionalisCentered

isCentered?: boolean

is body offset centered for rotation purpouses

isConvex

isConvex: boolean

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

OptionalisStatic

isStatic?: boolean

system.separate() doesn't move this body

OptionalisTrigger

isTrigger?: boolean

system.separate() doesn't trigger collision of this body

offset

offset: SATVector

each body may have offset from center

Optionalpadding

padding?: number

BHV padding for bounding box, preventing costly updates

Optionalsystem

system?: System<Body>

collisions system reference

Readonlytype

type: BodyType

type of body

ReadonlytypeGroup

typeGroup: BodyGroup

faster for comparision, inner, type of body as number

OptionaluserData

userData?: UserDataType

allows the user to set any misc data for client use

Accessors

scaleX

scaleY

  • get scaleY(): number

  • scale getter (y = x for Circle)

    Returns number

Methods

draw

  • draw(context): void

  • draw the collider

    Parameters

    • context: CanvasRenderingContext2D

    Returns void

drawBVH

  • drawBVH(context): void

  • draw the bounding box

    Parameters

    • context: CanvasRenderingContext2D

    Returns void

getAABBAsBBox

move

setAngle

setOffset

setPosition

setScale

Settings

Member Visibility

On This Page

Properties
Accessors
Methods