Class Stage

By extending this class, you can make your components keep their own state and animation.

Demo: https://kokomi-js.vercel.app/examples/#component

Hierarchy (View Summary)

Component
- Stage

Index

Constructors

Properties

ambientLight base center contactShadows? container emitter group pointLight presetData shadow spotLight

Methods

add addExisting adjustAll adjustLightPositions adjustShadow emit off on update

Constructors

constructor

new Stage(base: Base, config?: Partial<StageConfig>): Stage
Parameters
- base: Base
- config: Partial<StageConfig> = {}
Returns Stage
Overrides Component.constructor
- Defined in src/lights/stage.ts:56

Properties

ambientLight

ambientLight: AmbientLight

base

base: Base

center

center: Center

`Optional`contactShadows

contactShadows?: ContactShadows | null

container

container: Scene

emitter

emitter: Emitter<any>

group

group: Group

pointLight

pointLight: PointLight

presetData

presetData: PresetItem

shadow

shadow: boolean | "contact"

spotLight

spotLight: SpotLight

Methods

add

add(...object: Object3D<Object3DEventMap>[]): void
Parameters
- ...object: Object3D<Object3DEventMap>[]
Returns void
- Defined in src/lights/stage.ts:108

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/lights/stage.ts:96

adjustAll

adjustAll(): void
Returns void
- Defined in src/lights/stage.ts:113

adjustLightPositions

adjustLightPositions(): void
Returns void
- Defined in src/lights/stage.ts:117

adjustShadow

adjustShadow(): void
Returns void
- Defined in src/lights/stage.ts:137

emit

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

off

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

on

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

update

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