Class Sparkles

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 full)

Component
- Sparkles

Index

Constructors

Properties

base container emitter sparkles uj

Methods

addExisting emit off on update

Constructors

constructor

new Sparkles(base, config?): Sparkles
Parameters
- base: Base
- config: Partial<SparklesConfig> = {}
Returns Sparkles
Overrides Component.constructor
- Defined in src/shapes/sparkles.ts:99

Properties

base

base: Base

container

container: Scene

emitter

emitter: Emitter<any>

sparkles

sparkles: Points<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

uj

uj: UniformInjector

Methods

addExisting

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

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

update

update(time): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/shapes/sparkles.ts:170