Class TextGeometryAlpha

The class that generates THREE.BufferGeometry from 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 mesh = new THREE.Mesh(geometry, material)

TextGeometry

Hierarchy

  • BufferGeometry
    • TextGeometry

Constructors

constructor

Properties

attributes boundingBox boundingSphere drawRange groups id index isBufferGeometry morphAttributes morphTargetsRelative name type userData uuid

Accessors

option visibleGlyphs

Methods

addEventListener addGroup applyMatrix4 applyQuaternion center clearGroups clone computeBoundingBox computeBoundingSphere computeTangents computeVertexNormals copy deleteAttribute dispatchEvent dispose getAttribute getIndex hasAttribute hasEventListener lookAt normalizeNormals removeEventListener rotateX rotateY rotateZ scale setAttribute setDrawRange setFromPoints setIndex toJSON toNonIndexed translate update

Constructors

constructor

  • new TextGeometry(text, option?): TextGeometry
  • Alpha

    The constructor to create an instance of TextGeometry.

    Parameters

    • text: string

      Text to layout.

    • Optionaloption: any = {}

      An object conforming to TextGeometryOption.

    Returns TextGeometry

    Memberof

    TextGeometry

Properties

Alphaattributes

attributes: NormalBufferAttributes

This hashmap has as id the name of the attribute to be set and as value the THREE.BufferAttribute | buffer to set it to. Rather than accessing this property directly, use .setAttribute and .getAttribute to access attributes of this geometry.

Default Value

{}

AlphaboundingBox

boundingBox: null | Box3

Bounding box for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingBox().

Remarks

Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

AlphaboundingSphere

boundingSphere: null | Sphere

Bounding sphere for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingSphere().

Remarks

bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

Default Value

null

AlphadrawRange

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

Determines the part of the geometry to render. This should not be set directly, instead use .setDrawRange(...).

Remarks

For non-indexed THREE.BufferGeometry | BufferGeometry, count is the number of vertices to render.

Default Value

{ start: 0, count: Infinity }

Alphagroups

groups: GeometryGroup[]

Split the geometry into groups, each of which will be rendered in a separate WebGL draw call. This allows an array of materials to be used with the geometry.

Remarks

Every vertex and index must belong to exactly one group — groups must not share vertices or indices, and must not leave vertices or indices unused.

Default Value

[]

Alphaid

id: number

Unique number for this THREE.BufferGeometry | BufferGeometry instance.

Remarks

Expects a Integer

Alphaindex

index: null | BufferAttribute

Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles". Each triangle is associated with the indices of three vertices. This attribute therefore stores the index of each vertex for each triangular face. If this attribute is not set, the THREE.WebGLRenderer | renderer assumes that each three contiguous positions represent a single triangle.

Default Value

null

Readonly AlphaisBufferGeometry

isBufferGeometry: true

Read-only flag to check if a given object is of type BufferGeometry.

Remarks

This is a constant value

Default Value

true

AlphamorphAttributes

morphAttributes: {
    [name: string]: (BufferAttribute | InterleavedBufferAttribute)[];
}

Hashmap of THREE.BufferAttribute | BufferAttributes holding details of the geometry's morph targets.

Remarks

Once the geometry has been rendered, the morph attribute data cannot be changed. You will have to call .dispose(), and create a new instance of THREE.BufferGeometry | BufferGeometry.

Default Value

{}

AlphamorphTargetsRelative

morphTargetsRelative: boolean

Used to control the morph target behavior; when set to true, the morph target data is treated as relative offsets, rather than as absolute positions/normals.

Default Value

false

Alphaname

name: string

Optional name for this THREE.BufferGeometry | BufferGeometry instance.

Default Value

''

Readonly Alphatype

type: string

A Read-only string to check if this object type.

Remarks

Sub-classes will update this value.

Default Value

BufferGeometry

AlphauserData

userData: Record<string, any>

An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.

Default Value

{}

Alphauuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

Accessors

option

visibleGlyphs

Methods

addEventListener

  • addEventListener<T>(type, listener): void
  • Alpha

    Adds a listener to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, TextGeometry>

      The function that gets called when the event is fired.

    Returns void

  • addEventListener<T>(type, listener): void
  • Alpha

    Type Parameters

    • T extends string

    Parameters

    Returns void

addGroup

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

    Adds a group to this geometry

    Parameters

    • start: number
    • count: number
    • OptionalmaterialIndex: number

    Returns void

    See

    the groups property for details.

applyMatrix4

  • applyMatrix4(matrix): this
  • Alpha

    Applies the matrix transform to the geometry.

    Parameters

    • matrix: Matrix4

    Returns this

applyQuaternion

  • applyQuaternion(quaternion): this
  • Alpha

    Applies the rotation represented by the quaternion to the geometry.

    Parameters

    • quaternion: Quaternion

    Returns this

center

  • center(): this
  • Alpha

    Center the geometry based on the bounding box.

    Returns this

clearGroups

  • clearGroups(): void
  • Alpha

    Clears all groups.

    Returns void

clone

  • clone(): this
  • Alpha

    Creates a clone of this BufferGeometry

    Returns this

computeBoundingBox

  • computeBoundingBox(): void
  • Alpha

    The function that computes the bounding box of the geometry.

    Returns void

    Memberof

    TextGeometry

computeBoundingSphere

  • computeBoundingSphere(): void
  • Alpha

    The function that computes the bounding sphere of the geometry.

    Returns void

    Memberof

    TextGeometry

computeTangents

  • computeTangents(): void
  • Alpha

    Calculates and adds a tangent attribute to this geometry. The computation is only supported for indexed geometries and if position, normal, and uv attributes are defined

    Returns void

    Remarks

    When using a tangent space normal map, prefer the MikkTSpace algorithm provided by BufferGeometryUtils.computeMikkTSpaceTangents instead.

computeVertexNormals

  • computeVertexNormals(): void
  • Alpha

    Computes vertex normals for the given vertex data. For indexed geometries, the method sets each vertex normal to be the average of the face normals of the faces that share that vertex. For non-indexed geometries, vertices are not shared, and the method sets each vertex normal to be the same as the face normal.

    Returns void

copy

  • copy(source): this
  • Alpha

    Copies another BufferGeometry to this BufferGeometry.

    Parameters

    • source: BufferGeometry<NormalBufferAttributes>

    Returns this

deleteAttribute

  • deleteAttribute(name): this
  • Alpha

    Deletes the attribute with the specified name.

    Parameters

    • name: string

    Returns this

dispatchEvent

  • dispatchEvent<T>(event): void
  • Alpha

    Fire an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & {
          dispose: {};
      }[T]

      The event that gets fired.

    Returns void

dispose

  • dispose(): void
  • Alpha

    Frees the GPU-related resources allocated by this instance.

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

getAttribute

  • getAttribute<K>(name): BufferAttribute | InterleavedBufferAttribute
  • Alpha

    Returns the attribute with the specified name.

    Type Parameters

    • K extends string

    Parameters

    • name: K

    Returns BufferAttribute | InterleavedBufferAttribute

getIndex

  • getIndex(): null | BufferAttribute
  • Alpha

    Return the .index buffer.

    Returns null | BufferAttribute

hasAttribute

  • hasAttribute(name): boolean
  • Alpha

    Returns true if the attribute with the specified name exists.

    Parameters

    • name: string

    Returns boolean

hasEventListener

  • hasEventListener<T>(type, listener): boolean
  • Alpha

    Checks if listener is added to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, TextGeometry>

      The function that gets called when the event is fired.

    Returns boolean

  • hasEventListener<T>(type, listener): boolean
  • Alpha

    Type Parameters

    • T extends string

    Parameters

    Returns boolean

lookAt

  • lookAt(vector): this
  • Alpha

    Rotates the geometry to face a point in space.

    Parameters

    • vector: Vector3

      A world vector to look at.

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

normalizeNormals

  • normalizeNormals(): void
  • Alpha

    Every normal vector in a geometry will have a magnitude of 1

    Returns void

    Remarks

    This will correct lighting on the geometry surfaces.

removeEventListener

  • removeEventListener<T>(type, listener): void
  • Alpha

    Removes a listener from an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<{
          dispose: {};
      }[T], T, TextGeometry>

      The listener function that gets removed.

    Returns void

  • removeEventListener<T>(type, listener): void
  • Alpha

    Type Parameters

    • T extends string

    Parameters

    Returns void

rotateX

  • rotateX(angle): this
  • Alpha

    Rotate the geometry about the X axis. This is typically done as a one time operation, and not during a loop.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    Use THREE.Object3D.rotation | Object3D.rotation for typical real-time mesh rotation.

rotateY

  • rotateY(angle): this
  • Alpha

    Rotate the geometry about the Y axis.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

rotateZ

  • rotateZ(angle): this
  • Alpha

    Rotate the geometry about the Z axis.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

scale

  • scale(x, y, z): this
  • Alpha

    Scale the geometry data.

    Parameters

    • x: number

      Expects a Float

    • y: number

      Expects a Float

    • z: number

      Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

setAttribute

  • setAttribute<K>(name, attribute): this
  • Alpha

    Sets an attribute to this geometry with the specified name.

    Type Parameters

    • K extends string

    Parameters

    • name: K
    • attribute: BufferAttribute | InterleavedBufferAttribute

    Returns this

    Remarks

    Use this rather than the attributes property, because an internal hashmap of .attributes is maintained to speed up iterating over attributes.

setDrawRange

  • setDrawRange(start, count): void
  • Alpha

    Set the .drawRange property

    Parameters

    • start: number
    • count: number

      is the number of vertices or indices to render. Expects a Integer

    Returns void

    Remarks

    For non-indexed BufferGeometry, count is the number of vertices to render

setFromPoints

  • setFromPoints(points): this
  • Alpha

    Sets the attributes for this BufferGeometry from an array of points.

    Parameters

    • points: Vector3[] | Vector2[]

    Returns this

setIndex

  • setIndex(index): this
  • Alpha

    Set the THREE.BufferGeometry.index | .index buffer.

    Parameters

    • index: null | number[] | BufferAttribute

    Returns this

toJSON

  • toJSON(): BufferGeometryJSON
  • Alpha

    Convert the buffer geometry to three.js JSON Object/Scene format.

    Returns BufferGeometryJSON

toNonIndexed

  • toNonIndexed(): BufferGeometry<NormalBufferAttributes>
  • Alpha

    Return a non-index version of an indexed BufferGeometry.

    Returns BufferGeometry<NormalBufferAttributes>

translate

  • translate(x, y, z): this
  • Alpha

    Translate the geometry.

    Parameters

    • x: number

      Expects a Float

    • y: number

      Expects a Float

    • z: number

      Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

update

  • update(text, option?): void
  • Alpha

    The function to update the text.

    Parameters

    • text: string

      Text to layout.

    • Optionaloption: any = {}

      An object conforming to TextGeometryOption.

    Returns void

    Memberof

    TextGeometry

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods