Class CustomMesh

It contains a THREE.Mesh object in which you can custom its base material (which is based on THREE-CustomShaderMaterial). Also, it provides all the shadertoy uniforms.

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

Hierarchy (view full)

Component
- CustomMesh
  - RenderQuad
  - Text3D

Index

Constructors

constructor

new CustomMesh(base, config?): CustomMesh
Parameters
- base: Base
- config: Partial<CustomMeshConfig> = {}
Returns CustomMesh
Overrides Component.constructor
- Defined in src/shapes/customMesh.ts:65

Properties

base

base: Base

container

container: Scene

emitter

emitter: Emitter<any>

material

material: CustomShaderMaterial

mesh

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

uniformInjector

uniformInjector: UniformInjector

Methods

addExisting

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

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/customMesh.ts:100

Class CustomMesh

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomMesh

Properties

base

container

emitter

material

mesh

uniformInjector

Methods

addExisting

Returns void

emit

Parameters

Returns void

off

Parameters

Returns void

on

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page