Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextGeometry

The class that generates THREE.BufferGeometry from a BMFont data.

import * as THREE from 'three'
import TextGeometry from 'three-text-geometry'

const text: string = '.....text to layout.....'
const option: TextGeometryOption = {
   font: font, // BMFont data
}
const geometry = new TextGeometry(text, option)
const material = new THREE.MeshBasicMaterial({
   map: texture, // THREE.Texture data side: THREE.DoubleSide,
   transparent: true,
   color: 0x666666,
)
const mesth = new THREE.Mesh(geometry, material)
alpha

Hierarchy

  • BufferGeometry
    • TextGeometry

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • The constructor to creates an instance of TextGeometry.

    memberof

    TextGeometry

    Parameters

    • text: string

      Text to layout.

    • option: any = {}

    Returns TextGeometry

Properties

attributes

attributes: {}
default

{}

Type declaration

  • [name: string]: BufferAttribute | InterleavedBufferAttribute

boundingBox

boundingBox: null | Box3
default

null

boundingSphere

boundingSphere: null | Sphere
default

null

drawRange

drawRange: { count: number; start: number }
default

{ start: 0, count: Infinity }

Type declaration

  • count: number
  • start: number

drawcalls

drawcalls: any
deprecated

Use {@link BufferGeometry#groups .groups} instead.

groups

groups: { count: number; materialIndex?: number; start: number }[]
default

[]

id

id: number

Unique number of this buffergeometry instance

index

index: null | BufferAttribute
default

null

Readonly isBufferGeometry

isBufferGeometry: true

morphAttributes

morphAttributes: {}
default

{}

Type declaration

  • [name: string]: (BufferAttribute | InterleavedBufferAttribute)[]

morphTargetsRelative

morphTargetsRelative: boolean
default

false

name

name: string
default

''

offsets

offsets: any
deprecated

Use {@link BufferGeometry#groups .groups} instead.

type

type: string
default

'BufferGeometry'

userData

userData: {}
default

{}

Type declaration

  • [key: string]: any

uuid

uuid: string

Static MaxIndex

MaxIndex: number

Accessors

option

visibleGlyphs

Methods

addAttribute

  • addAttribute(name: string, attribute: BufferAttribute | InterleavedBufferAttribute): BufferGeometry
  • addAttribute(name: any, array: any, itemSize: any): any
  • deprecated

    Use {@link BufferGeometry#setAttribute .setAttribute()} instead.

    Parameters

    • name: string
    • attribute: BufferAttribute | InterleavedBufferAttribute

    Returns BufferGeometry

  • Parameters

    • name: any
    • array: any
    • itemSize: any

    Returns any

addDrawCall

  • addDrawCall(start: any, count: any, indexOffset?: any): void
  • deprecated

    Use {@link BufferGeometry#addGroup .addGroup()} instead.

    Parameters

    • start: any
    • count: any
    • Optional indexOffset: any

    Returns void

addEventListener

  • addEventListener<T>(type: T, listener: EventListener<Event, T, TextGeometry>): void

  • Adds a listener to an event type.

    Type parameters

    • T: string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, TextGeometry>

      The function that gets called when the event is fired.

    Returns void

addGroup

  • addGroup(start: number, count: number, materialIndex?: number): void

  • Parameters

    • start: number
    • count: number
    • Optional materialIndex: number

    Returns void

addIndex

  • addIndex(index: any): void
  • deprecated

    Use {@link BufferGeometry#setIndex .setIndex()} instead.

    Parameters

    • index: any

    Returns void

applyMatrix4

  • applyMatrix4(matrix: Matrix4): BufferGeometry

  • Bakes matrix transform directly into vertex coordinates.

    Parameters

    • matrix: Matrix4

    Returns BufferGeometry

applyQuaternion

  • applyQuaternion(q: Quaternion): BufferGeometry

  • Parameters

    • q: Quaternion

    Returns BufferGeometry

center

  • center(): BufferGeometry

  • Returns BufferGeometry

clearDrawCalls

  • clearDrawCalls(): void
  • deprecated

    Use {@link BufferGeometry#clearGroups .clearGroups()} instead.

    Returns void

clearGroups

  • clearGroups(): void

  • Returns void

clone

  • clone(): BufferGeometry

  • Returns BufferGeometry

computeBoundingBox

  • computeBoundingBox(): void

  • The function that computes bounding sphere of the geometry.

    memberof

    TextGeometry

    Returns void

computeBoundingSphere

  • computeBoundingSphere(): void

  • The function that computes bounding box of the geometry.

    memberof

    TextGeometry

    Returns void

computeTangents

  • computeTangents(): void

  • Computes and adds tangent attribute to this geometry.

    Returns void

computeVertexNormals

  • computeVertexNormals(): void

  • Computes vertex normals by averaging face normals.

    Returns void

copy

  • Parameters

    • source: BufferGeometry

    Returns TextGeometry

deleteAttribute

  • deleteAttribute(name: BuiltinShaderAttributeName | (string & {})): BufferGeometry

  • Parameters

    • name: BuiltinShaderAttributeName | (string & {})

    Returns BufferGeometry

dispatchEvent

  • dispatchEvent(event: Event): void

  • Fire an event type.

    Parameters

    • event: Event

    Returns void

dispose

  • dispose(): void

  • Disposes the object from memory. You need to call this when you want the bufferGeometry removed while the application is running.

    Returns void

getAttribute

  • getAttribute(name: BuiltinShaderAttributeName | (string & {})): BufferAttribute | InterleavedBufferAttribute

  • Parameters

    • name: BuiltinShaderAttributeName | (string & {})

    Returns BufferAttribute | InterleavedBufferAttribute

getIndex

  • getIndex(): null | BufferAttribute

  • Returns null | BufferAttribute

hasAttribute

  • hasAttribute(name: BuiltinShaderAttributeName | (string & {})): boolean

  • Parameters

    • name: BuiltinShaderAttributeName | (string & {})

    Returns boolean

hasEventListener

  • hasEventListener<T>(type: T, listener: EventListener<Event, T, TextGeometry>): boolean

  • Checks if listener is added to an event type.

    Type parameters

    • T: string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, TextGeometry>

      The function that gets called when the event is fired.

    Returns boolean

lookAt

  • lookAt(v: Vector3): void

  • Parameters

    • v: Vector3

    Returns void

merge

  • merge(geometry: BufferGeometry, offset?: number): BufferGeometry

  • Parameters

    • geometry: BufferGeometry
    • Optional offset: number

    Returns BufferGeometry

normalizeNormals

  • normalizeNormals(): void

  • Returns void

removeAttribute

  • removeAttribute(name: string): BufferGeometry
  • deprecated

    Use {@link BufferGeometry#deleteAttribute .deleteAttribute()} instead.

    Parameters

    • name: string

    Returns BufferGeometry

removeEventListener

  • removeEventListener<T>(type: T, listener: EventListener<Event, T, TextGeometry>): void

  • Removes a listener from an event type.

    Type parameters

    • T: string

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<Event, T, TextGeometry>

      The listener function that gets removed.

    Returns void

rotateX

  • rotateX(angle: number): BufferGeometry

  • Parameters

    • angle: number

    Returns BufferGeometry

rotateY

  • rotateY(angle: number): BufferGeometry

  • Parameters

    • angle: number

    Returns BufferGeometry

rotateZ

  • rotateZ(angle: number): BufferGeometry

  • Parameters

    • angle: number

    Returns BufferGeometry

scale

  • scale(x: number, y: number, z: number): BufferGeometry

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns BufferGeometry

setAttribute

  • setAttribute(name: BuiltinShaderAttributeName | (string & {}), attribute: BufferAttribute | InterleavedBufferAttribute): BufferGeometry

  • Parameters

    • name: BuiltinShaderAttributeName | (string & {})
    • attribute: BufferAttribute | InterleavedBufferAttribute

    Returns BufferGeometry

setDrawRange

  • setDrawRange(start: number, count: number): void

  • Parameters

    • start: number
    • count: number

    Returns void

setFromPoints

  • setFromPoints(points: Vector3[] | Vector2[]): BufferGeometry

  • Parameters

    • points: Vector3[] | Vector2[]

    Returns BufferGeometry

setIndex

  • setIndex(index: null | number[] | BufferAttribute): BufferGeometry

  • Parameters

    • index: null | number[] | BufferAttribute

    Returns BufferGeometry

toJSON

  • toJSON(): any

  • Returns any

toNonIndexed

  • toNonIndexed(): BufferGeometry

  • Returns BufferGeometry

translate

  • translate(x: number, y: number, z: number): BufferGeometry

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns BufferGeometry

update

  • update(text: string, option?: any): void

  • The function to update text.

    memberof

    TextGeometry

    Parameters

    • text: string

      Text to layout.

    • option: any = {}

    Returns void

Generated using TypeDoc