Class Shape

Base class for physics shapes (Circle, Polygon). Never instantiated directly — use new Circle(...) or Polygon.box(...) etc.

Hierarchy (View Summary)

Interactor
- Shape

Accessors

angDrag

get angDrag(): number
Angular drag coefficient for this shape.

Returns number
- Defined in src/shape/Shape.ts:242

area

get area(): number
Cross-sectional area of this shape.

Returns number
- Defined in src/shape/Shape.ts:228

body

get body(): Body
The Body this shape belongs to. Setting moves the shape between bodies.

Returns Body
- Defined in src/shape/Shape.ts:113
set body(value: Body | null): void
Parameters
- value: Body | null
Returns void
- Defined in src/shape/Shape.ts:121

bounds

get bounds(): AABB
World-space AABB of this shape (updated each step).

Returns AABB
- Defined in src/shape/Shape.ts:360

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 src/phys/Interactor.ts:117

castCapsule

get castCapsule(): Shape | null
Cast to Capsule, or null if this is not a capsule.

Returns Shape | null
- Defined in src/shape/Shape.ts:161

castCircle

get castCircle(): Shape | null
Cast to Circle, or null if this is not a circle.

Returns Shape | null
- Defined in src/shape/Shape.ts:141

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 src/phys/Interactor.ts:135

castPolygon

get castPolygon(): Shape | null
Cast to Polygon, or null if this is not a polygon.

Returns Shape | null
- Defined in src/shape/Shape.ts:151

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 src/phys/Interactor.ts:126

cbTypes

get cbTypes(): CbTypeSet
Set of callback types registered on this shape for event dispatch.

Returns CbTypeSet
Overrides Interactor.cbTypes
- Defined in src/shape/Shape.ts:301

filter

get filter(): InteractionFilter
The InteractionFilter controlling which shapes interact with this one.

Returns InteractionFilter
- Defined in src/shape/Shape.ts:263
set filter(value: InteractionFilter): void
Parameters
- value: InteractionFilter
Returns void
- Defined in src/shape/Shape.ts:267

fluidEnabled

get fluidEnabled(): boolean
If true, this shape participates in fluid interaction.

Returns boolean
- Defined in src/shape/Shape.ts:327
set fluidEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/shape/Shape.ts:331

fluidProperties

get fluidProperties(): FluidProperties
Fluid simulation properties for this shape. Auto-created on first access.

Returns FluidProperties
- Defined in src/shape/Shape.ts:277
set fluidProperties(value: FluidProperties): void
Parameters
- value: FluidProperties
Returns void
- Defined in src/shape/Shape.ts:286

group

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

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

id

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

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

inertia

get inertia(): number
Contribution to moment of inertia (about local centroid, unit density).

Returns number
- Defined in src/shape/Shape.ts:235

localCOM

get localCOM(): Vec2
Local-space centre of mass. Can be set to override the default shape centroid.

Returns Vec2
- Defined in src/shape/Shape.ts:182
set localCOM(value: Vec2): void
Parameters
- value: Vec2
Returns void
- Defined in src/shape/Shape.ts:196

material

get material(): Material
The Material assigned to this shape (controls friction, elasticity, density).

Returns Material
- Defined in src/shape/Shape.ts:249
set material(value: Material): void
Parameters
- value: Material
Returns void
- Defined in src/shape/Shape.ts:253

sensorEnabled

get sensorEnabled(): boolean
If true, this shape acts as a sensor (no physical response, only callbacks).

Returns boolean
- Defined in src/shape/Shape.ts:348
set sensorEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/shape/Shape.ts:352

type

get type(): ShapeType
The shape type: CIRCLE or POLYGON.

Returns ShapeType
- Defined in src/shape/Shape.ts:91

userData

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

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

worldCOM

get worldCOM(): Vec2
World-space centre of mass of this shape (read-only, lazy-computed).

Returns Vec2
- Defined in src/shape/Shape.ts:171

Methods

contains

contains(point: Vec2): boolean
Return true if the given world-space point lies inside this shape. Requires the shape to be attached to a Body.
Parameters
- point: Vec2
  The world-space point to test.
Returns boolean
True if the point is inside this shape.
- Defined in src/shape/Shape.ts:509

copy

copy(): Shape
Create a deep copy of this shape with the same type, geometry, material, and filter.

Returns Shape
A new Shape instance independent of this one.
- Defined in src/shape/Shape.ts:534

isBody

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

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

isCapsule

isCapsule(): boolean
Returns true if this is a Capsule shape.

Returns boolean
- Defined in src/shape/Shape.ts:106

isCircle

isCircle(): boolean
Returns true if this is a Circle shape.

Returns boolean
- Defined in src/shape/Shape.ts:96

isCompound

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

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

isPolygon

isPolygon(): boolean
Returns true if this is a Polygon shape.

Returns boolean
- Defined in src/shape/Shape.ts:101

isShape

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

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

rotate

rotate(angle: number): Shape
Rotate the shape's local vertices by angle radians.
Parameters
- angle: number
  Rotation in radians.
Returns Shape
this for chaining.
- Defined in src/shape/Shape.ts:443

scale

scale(scaleX: number, scaleY: number): Shape
Scale the shape's local geometry. Circles require uniform scaling.
Parameters
- scaleX: number
  Horizontal scale factor (must be non-zero).
- scaleY: number
  Vertical scale factor (must be non-zero).
Returns Shape
this for chaining.
- Defined in src/shape/Shape.ts:408

toString

toString(): string
Returns string
Overrides Interactor.toString
- Defined in src/shape/Shape.ts:540

transform

transform(matrix: { _inner: any }): Shape
Apply a Mat23 affine transform to the shape's local geometry.
Parameters
- matrix: { _inner: any }
  The transformation matrix (must be non-singular; Circles require equiorthogonal).
Returns Shape
this for chaining.
- Defined in src/shape/Shape.ts:474

translate

translate(translation: Vec2): Shape
Translate the shape's local vertices by the given vector (in-place).
Parameters
- translation: Vec2
  The displacement vector to apply.
Returns Shape
this for chaining.
- Defined in src/shape/Shape.ts:373