Documentation / @ripl/3d / Shape3D

Class: Shape3D<TState>

Defined in: 3d/src/core/shape.ts:80

Base class for 3D shapes, handling model transforms, face projection, shading, and hit testing.

Extends

• Shape<TState>

Extended by

• Cube
• Sphere
• Cylinder
• Cone
• Plane
• Torus

Type Parameters

Type Parameter	Default type
TState extends Shape3DState	Shape3DState

Constructors

Constructor

new Shape3D<TState>(type, options): Shape3D<TState>

Defined in: 3d/src/core/shape.ts:143

Parameters

Parameter	Type
type	string
options	Shape3DOptions<TState>

Returns

Shape3D<TState>

Overrides

Shape.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
abstract	public	boolean	false	Shape.abstract	core/src/core/element.ts:289
classList	readonly	Set<string>	undefined	Shape.classList	core/src/core/element.ts:287
context?	protected	Context<Element, Record<string, unknown>>	undefined	Shape.context	core/src/core/element.ts:283
data	public	unknown	undefined	Shape.data	core/src/core/element.ts:292
hitPath?	protected	ContextPath	undefined	-	3d/src/core/shape.ts:82
id	public	string	undefined	Shape.id	core/src/core/element.ts:285
parent?	public	Group<ElementEventMap>	undefined	Shape.parent	core/src/core/element.ts:291
pointerEvents	public	ElementPointerEvents	'all'	Shape.pointerEvents	core/src/core/element.ts:290
state	protected	TState	undefined	Shape.state	core/src/core/element.ts:282
type	readonly	string	undefined	Shape.type	core/src/core/element.ts:286
defaultKey	readonly	typeof defaultKey	undefined	Shape.defaultKey	core/src/core/disposer.ts:10

Accessors

direction

Get Signature

get direction(): TState["direction"]

Defined in: core/src/core/element.ts:296

Returns

TState["direction"]

Set Signature

set direction(value): void

Defined in: core/src/core/element.ts:300

Parameters

Parameter	Type
value	TState["direction"]

Returns

void

Inherited from

Shape.direction

---

fill

Get Signature

get fill(): TState["fill"]

Defined in: core/src/core/element.ts:304

Returns

TState["fill"]

Set Signature

set fill(value): void

Defined in: core/src/core/element.ts:308

Parameters

Parameter	Type
value	TState["fill"]

Returns

void

Inherited from

Shape.fill

---

filter

Get Signature

get filter(): TState["filter"]

Defined in: core/src/core/element.ts:312

Returns

TState["filter"]

Set Signature

set filter(value): void

Defined in: core/src/core/element.ts:316

Parameters

Parameter	Type
value	TState["filter"]

Returns

void

Inherited from

Shape.filter

---

font

Get Signature

get font(): TState["font"]

Defined in: core/src/core/element.ts:320

Returns

TState["font"]

Set Signature

set font(value): void

Defined in: core/src/core/element.ts:324

Parameters

Parameter	Type
value	TState["font"]

Returns

void

Inherited from

Shape.font

---

globalCompositeOperation

Get Signature

get globalCompositeOperation(): TState["globalCompositeOperation"]

Defined in: core/src/core/element.ts:336

Returns

TState["globalCompositeOperation"]

Set Signature

set globalCompositeOperation(value): void

Defined in: core/src/core/element.ts:340

Parameters

Parameter	Type
value	TState["globalCompositeOperation"]

Returns

void

Inherited from

Shape.globalCompositeOperation

---

lineCap

Get Signature

get lineCap(): TState["lineCap"]

Defined in: core/src/core/element.ts:344

Returns

TState["lineCap"]

Set Signature

set lineCap(value): void

Defined in: core/src/core/element.ts:348

Parameters

Parameter	Type
value	TState["lineCap"]

Returns

void

Inherited from

Shape.lineCap

---

lineDash

Get Signature

get lineDash(): TState["lineDash"]

Defined in: core/src/core/element.ts:352

Returns

TState["lineDash"]

Set Signature

set lineDash(value): void

Defined in: core/src/core/element.ts:356

Parameters

Parameter	Type
value	TState["lineDash"]

Returns

void

Inherited from

Shape.lineDash

---

lineDashOffset

Get Signature

get lineDashOffset(): TState["lineDashOffset"]

Defined in: core/src/core/element.ts:360

Returns

TState["lineDashOffset"]

Set Signature

set lineDashOffset(value): void

Defined in: core/src/core/element.ts:364

Parameters

Parameter	Type
value	TState["lineDashOffset"]

Returns

void

Inherited from

Shape.lineDashOffset

---

lineJoin

Get Signature

get lineJoin(): TState["lineJoin"]

Defined in: core/src/core/element.ts:368

Returns

TState["lineJoin"]

Set Signature

set lineJoin(value): void

Defined in: core/src/core/element.ts:372

Parameters

Parameter	Type
value	TState["lineJoin"]

Returns

void

Inherited from

Shape.lineJoin

---

lineWidth

Get Signature

get lineWidth(): TState["lineWidth"]

Defined in: core/src/core/element.ts:376

Returns

TState["lineWidth"]

Set Signature

set lineWidth(value): void

Defined in: core/src/core/element.ts:380

Parameters

Parameter	Type
value	TState["lineWidth"]

Returns

void

Inherited from

Shape.lineWidth

---

miterLimit

Get Signature

get miterLimit(): TState["miterLimit"]

Defined in: core/src/core/element.ts:384

Returns

TState["miterLimit"]

Set Signature

set miterLimit(value): void

Defined in: core/src/core/element.ts:388

Parameters

Parameter	Type
value	TState["miterLimit"]

Returns

void

Inherited from

Shape.miterLimit

---

opacity

Get Signature

get opacity(): TState["opacity"]

Defined in: core/src/core/element.ts:328

Returns

TState["opacity"]

Set Signature

set opacity(value): void

Defined in: core/src/core/element.ts:332

Parameters

Parameter	Type
value	TState["opacity"]

Returns

void

Inherited from

Shape.opacity

---

rotation

Get Signature

get rotation(): TState["rotation"]

Defined in: core/src/core/element.ts:488

Returns

TState["rotation"]

Set Signature

set rotation(value): void

Defined in: core/src/core/element.ts:492

Parameters

Parameter	Type
value	TState["rotation"]

Returns

void

Inherited from

Shape.rotation

---

rotationX

Get Signature

get rotationX(): TState["rotationX"]

Defined in: 3d/src/core/shape.ts:111

Returns

TState["rotationX"]

Set Signature

set rotationX(value): void

Defined in: 3d/src/core/shape.ts:115

Parameters

Parameter	Type
value	TState["rotationX"]

Returns

void

---

rotationY

Get Signature

get rotationY(): TState["rotationY"]

Defined in: 3d/src/core/shape.ts:119

Returns

TState["rotationY"]

Set Signature

set rotationY(value): void

Defined in: 3d/src/core/shape.ts:123

Parameters

Parameter	Type
value	TState["rotationY"]

Returns

void

---

rotationZ

Get Signature

get rotationZ(): TState["rotationZ"]

Defined in: 3d/src/core/shape.ts:127

Returns

TState["rotationZ"]

Set Signature

set rotationZ(value): void

Defined in: 3d/src/core/shape.ts:131

Parameters

Parameter	Type
value	TState["rotationZ"]

Returns

void

---

shadowBlur

Get Signature

get shadowBlur(): TState["shadowBlur"]

Defined in: core/src/core/element.ts:392

Returns

TState["shadowBlur"]

Set Signature

set shadowBlur(value): void

Defined in: core/src/core/element.ts:396

Parameters

Parameter	Type
value	TState["shadowBlur"]

Returns

void

Inherited from

Shape.shadowBlur

---

shadowColor

Get Signature

get shadowColor(): TState["shadowColor"]

Defined in: core/src/core/element.ts:400

Returns

TState["shadowColor"]

Set Signature

set shadowColor(value): void

Defined in: core/src/core/element.ts:404

Parameters

Parameter	Type
value	TState["shadowColor"]

Returns

void

Inherited from

Shape.shadowColor

---

shadowOffsetX

Get Signature

get shadowOffsetX(): TState["shadowOffsetX"]

Defined in: core/src/core/element.ts:408

Returns

TState["shadowOffsetX"]

Set Signature

set shadowOffsetX(value): void

Defined in: core/src/core/element.ts:412

Parameters

Parameter	Type
value	TState["shadowOffsetX"]

Returns

void

Inherited from

Shape.shadowOffsetX

---

shadowOffsetY

Get Signature

get shadowOffsetY(): TState["shadowOffsetY"]

Defined in: core/src/core/element.ts:416

Returns

TState["shadowOffsetY"]

Set Signature

set shadowOffsetY(value): void

Defined in: core/src/core/element.ts:420

Parameters

Parameter	Type
value	TState["shadowOffsetY"]

Returns

void

Inherited from

Shape.shadowOffsetY

---

stroke

Get Signature

get stroke(): TState["stroke"]

Defined in: core/src/core/element.ts:424

Returns

TState["stroke"]

Set Signature

set stroke(value): void

Defined in: core/src/core/element.ts:428

Parameters

Parameter	Type
value	TState["stroke"]

Returns

void

Inherited from

Shape.stroke

---

textAlign

Get Signature

get textAlign(): TState["textAlign"]

Defined in: core/src/core/element.ts:432

Returns

TState["textAlign"]

Set Signature

set textAlign(value): void

Defined in: core/src/core/element.ts:436

Parameters

Parameter	Type
value	TState["textAlign"]

Returns

void

Inherited from

Shape.textAlign

---

textBaseline

Get Signature

get textBaseline(): TState["textBaseline"]

Defined in: core/src/core/element.ts:440

Returns

TState["textBaseline"]

Set Signature

set textBaseline(value): void

Defined in: core/src/core/element.ts:444

Parameters

Parameter	Type
value	TState["textBaseline"]

Returns

void

Inherited from

Shape.textBaseline

---

transformOriginX

Get Signature

get transformOriginX(): TState["transformOriginX"]

Defined in: core/src/core/element.ts:496

Returns

TState["transformOriginX"]

Set Signature

set transformOriginX(value): void

Defined in: core/src/core/element.ts:500

Parameters

Parameter	Type
value	TState["transformOriginX"]

Returns

void

Inherited from

Shape.transformOriginX

---

transformOriginY

Get Signature

get transformOriginY(): TState["transformOriginY"]

Defined in: core/src/core/element.ts:504

Returns

TState["transformOriginY"]

Set Signature

set transformOriginY(value): void

Defined in: core/src/core/element.ts:508

Parameters

Parameter	Type
value	TState["transformOriginY"]

Returns

void

Inherited from

Shape.transformOriginY

---

transformScaleX

Get Signature

get transformScaleX(): TState["transformScaleX"]

Defined in: core/src/core/element.ts:472

Returns

TState["transformScaleX"]

Set Signature

set transformScaleX(value): void

Defined in: core/src/core/element.ts:476

Parameters

Parameter	Type
value	TState["transformScaleX"]

Returns

void

Inherited from

Shape.transformScaleX

---

transformScaleY

Get Signature

get transformScaleY(): TState["transformScaleY"]

Defined in: core/src/core/element.ts:480

Returns

TState["transformScaleY"]

Set Signature

set transformScaleY(value): void

Defined in: core/src/core/element.ts:484

Parameters

Parameter	Type
value	TState["transformScaleY"]

Returns

void

Inherited from

Shape.transformScaleY

---

translateX

Get Signature

get translateX(): TState["translateX"]

Defined in: core/src/core/element.ts:456

Returns

TState["translateX"]

Set Signature

set translateX(value): void

Defined in: core/src/core/element.ts:460

Parameters

Parameter	Type
value	TState["translateX"]

Returns

void

Inherited from

Shape.translateX

---

translateY

Get Signature

get translateY(): TState["translateY"]

Defined in: core/src/core/element.ts:464

Returns

TState["translateY"]

Set Signature

set translateY(value): void

Defined in: core/src/core/element.ts:468

Parameters

Parameter	Type
value	TState["translateY"]

Returns

void

Inherited from

Shape.translateY

---

x

Get Signature

get x(): TState["x"]

Defined in: 3d/src/core/shape.ts:87

Returns

TState["x"]

Set Signature

set x(value): void

Defined in: 3d/src/core/shape.ts:91

Parameters

Parameter	Type
value	TState["x"]

Returns

void

---

y

Get Signature

get y(): TState["y"]

Defined in: 3d/src/core/shape.ts:95

Returns

TState["y"]

Set Signature

set y(value): void

Defined in: 3d/src/core/shape.ts:99

Parameters

Parameter	Type
value	TState["y"]

Returns

void

---

z

Get Signature

get z(): TState["z"]

Defined in: 3d/src/core/shape.ts:103

Returns

TState["z"]

Set Signature

set z(value): void

Defined in: 3d/src/core/shape.ts:107

Parameters

Parameter	Type
value	TState["z"]

Returns

void

---

zIndex

Get Signature

get zIndex(): number

Defined in: 3d/src/core/shape.ts:135

Returns

number

Set Signature

set zIndex(_value): void

Defined in: 3d/src/core/shape.ts:139

Parameters

Parameter	Type
_value	number

Returns

void

Overrides

Shape.zIndex

Methods

clone()

clone(): Element<TState, ElementEventMap>

Defined in: core/src/core/element.ts:565

Creates a shallow clone of this element with the same id, classes, and state.

Returns

Element<TState, ElementEventMap>

Inherited from

Shape.clone

---

computeFaces()

protected computeFaces(): Face3D[]

Defined in: 3d/src/core/shape.ts:162

Returns

Face3D[]

---

destroy()

destroy(): void

Defined in: core/src/core/element.ts:642

Emits a destroyed event, clears all listeners, and disposes retained resources.

Returns

void

Inherited from

Shape.destroy

---

dispose()

protected dispose(key?): void

Defined in: core/src/core/disposer.ts:24

Disposes all resources under the given key, or all resources if no key is provided.

Parameters

Parameter	Type
key?	PropertyKey

Returns

void

Inherited from

Shape.dispose

---

emit()

Call Signature

emit<TEvent>(event): TEvent

Defined in: core/src/core/event-bus.ts:127

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter	Default type
TEvent extends Event<undefined>	Event<undefined>

Parameters

Parameter	Type
event	TEvent

Returns

TEvent

Inherited from

Shape.emit

Call Signature

emit<TEvent>(type, data): Event<ElementEventMap[TEvent]>

Defined in: core/src/core/event-bus.ts:128

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter
TEvent extends keyof ElementEventMap

Parameters

Parameter	Type
type	TEvent
data	ElementEventMap[TEvent]

Returns

Event<ElementEventMap[TEvent]>

Inherited from

Shape.emit

---

getBoundingBox()

getBoundingBox(): Box

Defined in: 3d/src/core/shape.ts:188

Returns the axis-aligned bounding box for this element. Override in subclasses for accurate geometry.

Returns

Box

Overrides

Shape.getBoundingBox

---

getDepth()

getDepth(context): number

Defined in: 3d/src/core/shape.ts:184

Returns the projected depth of this shape's origin in the given 3D context.

Parameters

Parameter	Type
context	Context3D

Returns

number

---

getModelMatrix()

protected getModelMatrix(): Matrix4

Defined in: 3d/src/core/shape.ts:166

Returns

Matrix4

---

getStateValue()

protected getStateValue<TKey>(key): TState[TKey]

Defined in: core/src/core/element.ts:534

Reads a state value, falling back to the parent’s value if the local value is nil (property inheritance).

Type Parameters

Type Parameter
TKey extends string | number | symbol

Parameters

Parameter	Type
key	TKey

Returns

TState[TKey]

Inherited from

Shape.getStateValue

---

has()

has(type): boolean

Defined in: core/src/core/event-bus.ts:84

Returns whether there are any listeners registered for the given event type.

Parameters

Parameter	Type
type	keyof ElementEventMap

Returns

boolean

Inherited from

Shape.has

---

interpolate()

interpolate(newState, interpolators?): Interpolator<void>

Defined in: core/src/core/element.ts:585

Creates an interpolator that transitions from the current state towards the target state, supporting keyframes and custom interpolator overrides.

Parameters

Parameter	Type
newState	Partial<ElementInterpolationState<TState>>
interpolators	Partial<ElementInterpolators<TState>>

Returns

Interpolator<void>

Inherited from

Shape.interpolate

---

intersectsWith()

intersectsWith(x, y, options?): boolean

Defined in: 3d/src/core/shape.ts:306

Tests whether a point intersects this element’s bounding box. Override for custom hit testing.

Parameters

Parameter	Type
x	number
y	number
options?	Partial<ElementIntersectionOptions>

Returns

boolean

Overrides

Shape.intersectsWith

---

off()

off<TEvent>(type, handler): void

Defined in: core/src/core/event-bus.ts:102

Removes a previously registered handler for the given event type.

Type Parameters

Type Parameter
TEvent extends keyof ElementEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<ElementEventMap[TEvent]>

Returns

void

Inherited from

Shape.off

---

on()

on<TEvent>(event, handler, options?): Disposable

Defined in: core/src/core/element.ts:547

Subscribes a handler to the given event type and returns a disposable for cleanup.

Type Parameters

Type Parameter
TEvent extends keyof ElementEventMap

Parameters

Parameter	Type
event	TEvent
handler	EventHandler<ElementEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

Shape.on

---

once()

once<TEvent>(type, handler, options?): Disposable

Defined in: core/src/core/event-bus.ts:117

Subscribes a handler that is automatically removed after it fires once.

Type Parameters

Type Parameter
TEvent extends keyof ElementEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<ElementEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

Shape.once

---

render()

render(context): void

Defined in: 3d/src/core/shape.ts:223

Renders this element by applying transforms and context state, then invoking the optional callback.

Parameters

Parameter	Type
context	Context

Returns

void

Overrides

Shape.render

---

retain()

protected retain(value, key?): void

Defined in: core/src/core/disposer.ts:13

Registers a disposable resource under an optional key for later cleanup.

Parameters

Parameter	Type	Default value
value	Disposable	undefined
key	PropertyKey	Disposer.defaultKey

Returns

void

Inherited from

Shape.retain

---

setStateValue()

protected setStateValue<TKey>(key, value): void

Defined in: 3d/src/core/shape.ts:157

Sets a state value and emits an updated event.

Type Parameters

Type Parameter
TKey extends string | number | symbol

Parameters

Parameter	Type
key	TKey
value	TState[TKey]

Returns

void

Overrides

Shape.setStateValue

---

transformVertices()

protected transformVertices(vertices, matrix?): Vector3[]

Defined in: 3d/src/core/shape.ts:177

Parameters

Parameter	Type
vertices	Vector3[]
matrix?	Matrix4

Returns

Vector3[]