Class Text3D

A mesh using TextGeometry to render 3D text.

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

Hierarchy (view full)

CustomMesh
- Text3D

Index

Constructors

Properties

base container emitter material mesh uniformInjector

Methods

addExisting emit off on update

Constructors

constructor

new Text3D(base, text, font, textParams?, config?): Text3D
Parameters
- base: Base
- text: string
- font: Font
- textParams: TextGeometryParameters = ...
- config: Partial<CustomMeshConfig> = {}
Returns Text3D
Overrides CustomMesh.constructor
- Defined in src/shapes/text3D.ts:29

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
Inherited from CustomMesh.addExisting
- Defined in src/shapes/customMesh.ts:97

emit

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

off

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

on

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

update

update(time): void
Parameters
- time: number
Returns void
Inherited from CustomMesh.update
- Defined in src/shapes/customMesh.ts:100