Class Box

A cute box mesh that we can see everywhere.

Hierarchy (view full)

Component
- Box

Index

Constructors

Properties

base container emitter mesh

Methods

addExisting emit off on spin update

Constructors

constructor

new Box(base, config?): Box
Parameters
- base: Base
- config: Partial<BoxConfig> = {}
Returns Box
Overrides Component.constructor
- Defined in src/shapes/box.ts:19

Properties

base

base: Base

container

container: Scene

emitter

emitter: Emitter<any>

mesh

mesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Methods

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/shapes/box.ts:38

emit

emit(type, event?): void
Parameters
- type: string
- event: any = {}
Returns void
Inherited from Component.emit
- Defined in src/components/component.ts:41

off

off(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.off
- Defined in src/components/component.ts:37

on

on(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.on
- Defined in src/components/component.ts:33

spin

spin(time, axis?, speed?): void
Parameters
- time: number
- axis: "x" | "y" | "z" = "y"
- speed: number = 1
Returns void
- Defined in src/shapes/box.ts:41

update

update(time): void
Parameters
- time: number
Returns void
Inherited from Component.update
- Defined in src/components/component.ts:29