Class Compound

A compound physics object — a hierarchical grouping of Bodies, Constraints, and other Compounds.

Fully modernized — uses ZPP_Compound directly (extracted to TypeScript).

Hierarchy (View Summary)

Interactor
- Compound

Index

Constructors

Accessors

bodies castBody castCompound castShape cbTypes compound compounds constraints group id space userData

Methods

breakApart COM copy isBody isCompound isShape rotate toString translate visitBodies visitCompounds visitConstraints

Constructors

constructor

new Compound(): Compound
Returns Compound
Overrides Interactor.constructor
- Defined in packages/nape-js/src/phys/Compound.ts:20

Accessors

bodies

get bodies(): object
Bodies in this compound.

Returns object
- Defined in packages/nape-js/src/phys/Compound.ts:68

castBody

get castBody(): any
Cast to Body — returns the Body wrapper if this is a Body, else null.

Returns any
Inherited from Interactor.castBody
- Defined in packages/nape-js/src/phys/Interactor.ts:117

castCompound

get castCompound(): any
Cast to Compound — returns the Compound wrapper if this is a Compound, else null.

Returns any
Inherited from Interactor.castCompound
- Defined in packages/nape-js/src/phys/Interactor.ts:135

castShape

get castShape(): any
Cast to Shape — returns the Shape wrapper if this is a Shape, else null.

Returns any
Inherited from Interactor.castShape
- Defined in packages/nape-js/src/phys/Interactor.ts:126

cbTypes

get cbTypes(): any
Callback types assigned to this interactor.

Returns any
Inherited from Interactor.cbTypes
- Defined in packages/nape-js/src/phys/Interactor.ts:109

compound

get compound(): Compound | null
Parent compound, or null if this is a root compound.

Returns Compound | null
- Defined in packages/nape-js/src/phys/Compound.ts:87
set compound(value: Compound | null): void
Parameters
- value: Compound | null
Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:91

compounds

get compounds(): object
Child compounds in this compound.

Returns object
- Defined in packages/nape-js/src/phys/Compound.ts:78

constraints

get constraints(): object
Constraints in this compound.

Returns object
- Defined in packages/nape-js/src/phys/Compound.ts:73

group

get group(): InteractionGroup | null
The interaction group this interactor belongs to.

Returns InteractionGroup | null
Inherited from Interactor.group
- Defined in packages/nape-js/src/phys/Interactor.ts:99
set group(value: InteractionGroup | null): void
Parameters
- value: InteractionGroup | null
Returns void
Inherited from Interactor.group
- Defined in packages/nape-js/src/phys/Interactor.ts:103

id

get id(): number
Unique numeric identifier for this interactor.

Returns number
Inherited from Interactor.id
- Defined in packages/nape-js/src/phys/Interactor.ts:86

space

get space(): Space | null
Space this compound belongs to (only settable on root compounds).

Returns Space | null
- Defined in packages/nape-js/src/phys/Compound.ts:110
set space(value: Space | null): void
Parameters
- value: Space | null
Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:114

userData

get userData(): Record<string, unknown>
User-defined data storage object.

Returns Record<string, unknown>
Inherited from Interactor.userData
- Defined in packages/nape-js/src/phys/Interactor.ts:91

Methods

breakApart

breakApart(): void
Distribute all children to the parent compound or space, then remove.

Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:147

COM

COM(weak?: boolean): Vec2
Calculate the center of mass of all bodies in this compound.
Parameters
- weak: boolean = false
Returns Vec2
- Defined in packages/nape-js/src/phys/Compound.ts:200

copy

copy(): Compound
Deep copy of this compound and all its children.

Returns Compound
- Defined in packages/nape-js/src/phys/Compound.ts:142

isBody

isBody(): boolean
Returns true if this interactor is a Body.

Returns boolean
Inherited from Interactor.isBody
- Defined in packages/nape-js/src/phys/Interactor.ts:153

isCompound

isCompound(): boolean
Returns true if this interactor is a Compound.

Returns boolean
Inherited from Interactor.isCompound
- Defined in packages/nape-js/src/phys/Interactor.ts:158

isShape

isShape(): boolean
Returns true if this interactor is a Shape.

Returns boolean
Inherited from Interactor.isShape
- Defined in packages/nape-js/src/phys/Interactor.ts:148

rotate

rotate(centre: Vec2, angle: number): Compound
Rotate all bodies in this compound around the given centre point.
Parameters
- centre: Vec2
- angle: number
Returns Compound
- Defined in packages/nape-js/src/phys/Compound.ts:267

toString

toString(): string
Returns string
Overrides Interactor.toString
- Defined in packages/nape-js/src/phys/Compound.ts:289

translate

translate(translation: Vec2): Compound
Translate all bodies in this compound by the given vector.
Parameters
- translation: Vec2
Returns Compound
- Defined in packages/nape-js/src/phys/Compound.ts:244

visitBodies

visitBodies(lambda: (body: Body) => void): void
Recursively visit all bodies in this compound and its sub-compounds.
Parameters
- lambda: (body: Body) => void
Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:152

visitCompounds

visitCompounds(lambda: (compound: Compound) => void): void
Recursively visit all sub-compounds in this compound.
Parameters
- lambda: (compound: Compound) => void
Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:186

visitConstraints

visitConstraints(lambda: (constraint: Constraint) => void): void
Recursively visit all constraints in this compound and its sub-compounds.
Parameters
- lambda: (constraint: Constraint) => void
Returns void
- Defined in packages/nape-js/src/phys/Compound.ts:169