Class Environment

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
- Environment

Index

Constructors

Properties

base container cubeCamera emitter fbo ignoreObjects virtualScene

Accessors

Methods

add addExisting emit off on update

Constructors

constructor

new Environment(base: Base, config?: Partial<EnvironmentConfig>): Environment
Parameters
- base: Base
- config: Partial<EnvironmentConfig> = {}
Returns Environment
Overrides Component.constructor
- Defined in src/lights/environment.ts:21

Properties

base

base: Base

container

container: Scene

cubeCamera

cubeCamera: CubeCamera

emitter

emitter: Emitter<any>

fbo

fbo: WebGLCubeRenderTarget

ignoreObjects

ignoreObjects: Object3D<Object3DEventMap>[]

virtualScene

virtualScene: Scene

Accessors

texture

get texture(): CubeTexture<unknown>
Returns CubeTexture<unknown>
- Defined in src/lights/environment.ts:56

Methods

add

add(obj: Object3D): void
Parameters
- obj: Object3D
Returns void
- Defined in src/lights/environment.ts:53

addExisting

addExisting(): void
Returns void
Inherited from Component.addExisting
- Defined in src/components/component.ts:25

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(): void
Returns void
Overrides Component.update
- Defined in src/lights/environment.ts:44