Class: Text

Returns

World-space edge position (center + half-bounding-box offset).

Inherited from

TexturedMobject._getEdgeInDirection

_handoffTextureMap()

protected _handoffTextureMap(material, nextTexture, previousTexture): void

Defined in: core/TexturedMobject.ts:57

Sets material.map, marks material dirty, and disposes previous texture when replaced.

Parameters

material

MeshBasicMaterial

nextTexture

Texture<unknown, TextureEventMap>

previousTexture

Texture<unknown, TextureEventMap>

Returns

void

Inherited from

TexturedMobject._handoffTextureMap

_initCanvas()

protected _initCanvas(): void

Defined in: mobjects/text/Text.ts:193

Initialize the off-screen canvas

Returns

void

_localToWorld()

protected _localToWorld(p): Vector3Tuple

Defined in: core/Mobject.ts:387

LOCAL point -> WORLD (the frame this node's points live in; this node's own transform IS applied).

Parameters

p

Returns

Post

result === this._worldMatrix() * p

Inherited from

TexturedMobject._localToWorld

_markDirty()

_markDirty(): void

Defined in: core/Mobject.ts:920

Mark this node's render/transform state stale and propagate the flag to the root. World-space geometry of any node depends on its ancestors' transforms, so a change anywhere must invalidate the whole ancestor chain; the invariant "a clean node has a clean subtree" then lets _syncToThree()/root-sync skip untouched branches safely.

Returns

void

Post

this._dirty && (this.parent => this.parent._dirty)

Inherited from

TexturedMobject._markDirty

_markDirtyUpward()

_markDirtyUpward(): void

Defined in: core/Mobject.ts:931

Alias for _markDirty. Retained as the single override point for subclasses (e.g. VMobject) that must also invalidate baked geometry when a mutation propagates upward; transform-only changes call _markDirty() directly.

Returns

void

Inherited from

TexturedMobject._markDirtyUpward

_measureText()

protected _measureText(): object

Defined in: mobjects/text/Text.ts:297

Split text into lines and measure dimensions

Returns

object

Object with lines array and canvas dimensions

height

height: number

lines

lines: string[]

width

width: number

_normalizeChildrenInto()

protected _normalizeChildrenInto(worldMatrix): void

Defined in: core/Mobject.ts:836

Recurse normalizeTransform into children, composing each child's own matrix onto worldMatrix so every descendant flattens into the same frame.

Parameters

worldMatrix

Matrix4

Returns

void

Inherited from

TexturedMobject._normalizeChildrenInto

_ownMatrix()

_ownMatrix(): Matrix4

Defined in: core/Mobject.ts:969

This node's transform matrix in isolation — position, rotation, and scale composed together, with no ancestor contribution.

Returns

Matrix4

Post

this.parent === null => this._computeWorldMatrix() === this._computeOwnMatrix()

Post

this.parent !== null => this._computeWorldMatrix() === this.parent._computeWorldMatrix() * this._computeOwnMatrix()

Inherited from

TexturedMobject._ownMatrix

_renderToCanvas()

protected _renderToCanvas(): void

Defined in: mobjects/text/Text.ts:329

Render text to the off-screen canvas

Returns

void

_root()

_root(): Mobject

Defined in: core/Mobject.ts:940

The topmost ancestor (the node with no parent).

Returns

Inherited from

TexturedMobject._root

_rotateAboutParentLocalPoint()

protected _rotateAboutParentLocalPoint(angle, axis, pivotLocal): void

Defined in: core/Mobject.ts:356

Rotate about a pivot expressed in this node's PARENT-local frame (the same frame as this.position). No world-space conversion is done.

Parameters

angle

number

axis

pivotLocal

Returns

void

Pre

pivotLocal is in the same frame as this.position (parent-local)

Post

the parent-local pivot point is fixed; this.position rotates about it

Post

this.rotation === old.rotation composed with the requested rotation

Inherited from

TexturedMobject._rotateAboutParentLocalPoint

_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: mobjects/text/Text.ts:577

Sync material properties to Three.js

Returns

void

Overrides

TexturedMobject._syncMaterialToThree

_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:870

Returns

void

Inherited from

TexturedMobject._syncToThree

_syncWorldMatrices()

_syncWorldMatrices(): Object3D

Defined in: core/Mobject.ts:661

Refresh the THREE world matrices so a geometry query reads current transforms, and return the backing object. World coordinates depend on every ancestor's transform, so we sync from the root (the dirty invariant — see _markDirty — lets the recursion skip clean subtrees). _syncToThree only copies locals onto the THREE objects; setFromObject won't walk up to refresh matrixWorld, so we flush ancestors (true) and descendants (true) here. Shared by getBounds() and getBoundingBox() so both stay consistent.

Returns

Object3D

Pre

!this.isEmpty()

Post

result.min <= result.max component-wise

Inherited from

TexturedMobject._syncWorldMatrices

_updateMesh()

protected _updateMesh(): void

Defined in: mobjects/text/Text.ts:461

Update the mesh geometry to match new dimensions

Returns

void

_worldMatrix()

_worldMatrix(): Matrix4

Defined in: core/Mobject.ts:974

Returns

Matrix4

Inherited from

TexturedMobject._worldMatrix

_worldToLocal()

protected _worldToLocal(p): Vector3Tuple

Defined in: core/Mobject.ts:397

WORLD point -> this node's LOCAL frame. Inverse of _localToWorld.

Parameters

p

Returns

Post

result === this._worldMatrix().invert() * p

Inherited from

TexturedMobject._worldToLocal

add()

add(...mobjects): this

Defined in: core/Mobject.ts:481

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

TexturedMobject.add

addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:1010

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

TexturedMobject.addUpdater

alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:713

Parameters

target

direction

Returns

this

Inherited from

TexturedMobject.alignTo

applyContentFrom()

applyContentFrom(other): void

Defined in: mobjects/text/Text.ts:551

Copy class-authoritative content metadata from another textured mobject so that future sync cycles and API reads (e.g. getText()) reflect the target's content.

Parameters

other

TexturedMobject

Returns

void

Overrides

TexturedMobject.applyContentFrom

applyFunction()

applyFunction(fn, options?): this

Defined in: core/Mobject.ts:1068

Parameters

fn

(point) => number[]

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.applyFunction

applyFunctionAboutPoint()

applyFunctionAboutPoint(fn, aboutPoint): this

Defined in: core/Mobject.ts:1047

Apply a function to every descendant's world-space points, about a given point. Recurses the family and delegates to _applyFunctionAboutPoint on each node.

Parameters

fn

(pts) => number[][]

aboutPoint

number[] = ...

Returns

this

Pre

fn(pts).length === pts.length

Post

m.getPoints()[i] === old.m.getPoints().map(p => fn([p - aboutPoint]) + aboutPoint)[i] // for every descendant m

Inherited from

TexturedMobject.applyFunctionAboutPoint

applyMatrix()

applyMatrix(matrix, options?): this

Defined in: core/Mobject.ts:1076

Parameters

matrix

number[][]

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.applyMatrix

applyTextureFrom()

applyTextureFrom(other): void

Defined in: mobjects/text/Text.ts:525

Copy texture/material-relevant state from another textured mobject.

Parameters

other

TexturedMobject

Returns

void

Overrides

TexturedMobject.applyTextureFrom

applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:998

Parameters

func

(mobject) => void

Returns

this

Inherited from

TexturedMobject.applyToFamily

applyVisualSize()

applyVisualSize(width, height): void

Defined in: mobjects/text/Text.ts:559

Update class-authoritative visual size state so later sync cycles do not revert display dimensions set during transform finish.

Parameters

width

number

height

number

Returns

void

Overrides

TexturedMobject.applyVisualSize

become()

become(other): this

Defined in: core/Mobject.ts:592

Parameters

other

Returns

this

Inherited from

TexturedMobject.become

center()

center(): this

Defined in: core/Mobject.ts:772

Returns

this

Inherited from

TexturedMobject.center

clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:1022

Returns

this

Inherited from

TexturedMobject.clearUpdaters

copy()

copy(): Text

Defined in: mobjects/text/Text.ts:658

Create a copy of this Text mobject

Returns

Text

Overrides

TexturedMobject.copy

disableChildZLayering()

disableChildZLayering(): this

Defined in: core/Mobject.ts:905

Disable the 2D draw-order z-layering offset (idx * 0.01 per non-first child, applied in _syncToThree) for this node and its whole subtree.

The offset is a flat-2D hack that fakes paint order by nudging later siblings toward the camera. Under a 3D perspective camera with real depth sorting it instead corrupts geometry: a group's children drift along world-z proportionally to their index (issue #465). ThreeDScene calls this on every added mobject so 3D scenes opt out. Because the offset is gated on the parent's flag, setting it on a container also covers children added later.

Returns

this

Inherited from

TexturedMobject.disableChildZLayering

dispose()

dispose(): void

Defined in: mobjects/text/Text.ts:708

Clean up Three.js and canvas resources

Returns

void

Overrides

TexturedMobject.dispose

flip()

flip(axis, options?): this

Defined in: core/Mobject.ts:403

Parameters

axis

Vector3Tuple = ...

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.flip

generateTarget()

generateTarget(): Mobject

Defined in: core/Mobject.ts:1091

Returns

Inherited from

TexturedMobject.generateTarget

getBottom()

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:751

Returns

Inherited from

TexturedMobject.getBottom

getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:732

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

TexturedMobject.getBoundingBox

getBounds()

getBounds(): object

Defined in: core/Mobject.ts:679

World-space axis-aligned bounding box.

Uses Box3.setFromObject() via the Three.js subtree. This works for all standard geometry types without a renderer. VMobject overrides this with point math because Line2's LineGeometry is incompatible with Box3.setFromObject() — see PointBounds.ts for the full explanation.

Returns

object

max

max: object

max.x

x: number

max.y

y: number

max.z

z: number

min

min: object

min.x

x: number

min.y

y: number

min.z

z: number

Pre

!this.isEmpty()

Post

result.min <= result.max component-wise

Inherited from

TexturedMobject.getBounds

getCenter()

getCenter(): Vector3Tuple

Defined in: mobjects/text/Text.ts:651

Get the center of this text mobject

Returns

Overrides

TexturedMobject.getCenter

getDisplayMeshes()

getDisplayMeshes(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>[]

Defined in: mobjects/text/Text.ts:513

Return the meshes that visually represent this mobject. Textured morph code can use this for strict single-mesh validation.

Returns

Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>[]

Overrides

TexturedMobject.getDisplayMeshes

getDisplayMeshLength()

getDisplayMeshLength(): number

Defined in: mobjects/text/Text.ts:509

Return how many display meshes this textured mobject contributes.

Returns

number

Overrides

TexturedMobject.getDisplayMeshLength

getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:745

Parameters

direction

Returns

Inherited from

TexturedMobject.getEdge

getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:1004

Returns

Mobject[]

Inherited from

TexturedMobject.getFamily

getFontFamily()

getFontFamily(): string

Defined in: mobjects/text/Text.ts:250

Get the current font family

Returns

string

getFontSize()

getFontSize(): number

Defined in: mobjects/text/Text.ts:229

Get the current font size

Returns

number

getGlyphGroup()

getGlyphGroup(): TextGlyphGroup

Defined in: mobjects/text/Text.ts:594

Get the cached TextGlyphGroup (null until loadGlyphs() resolves).

Returns

TextGlyphGroup

getHeight()

getHeight(): number

Defined in: mobjects/text/Text.ts:278

Get text height in world units

Returns

number

Overrides

TexturedMobject.getHeight

getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:754

Returns

Inherited from

TexturedMobject.getLeft

getLocalCenter()

getLocalCenter(): Vector3Tuple

Defined in: core/Mobject.ts:643

Get center in this mobject's parent coordinate frame.

Includes this node's own local transform, excludes ancestor transforms.

Returns

Post

this.parent === null => result === this.getCenter()

Post

this.parent !== null => result === parent._computeWorldMatrix().invert() * this.getCenter()

Inherited from

TexturedMobject.getLocalCenter

getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:757

Returns

Inherited from

TexturedMobject.getRight

getText()

getText(): string

Defined in: mobjects/text/Text.ts:208

Get the current text content

Returns

string

getTextureMesh()

getTextureMesh(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

Defined in: mobjects/text/Text.ts:644

Get the texture mesh (for animation cross-fade access).

Returns

Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:944

Returns

Object3D

Inherited from

TexturedMobject.getThreeObject

getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:748

Returns

Inherited from

TexturedMobject.getTop

getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:1029

Returns

UpdaterFunction[]

Inherited from

TexturedMobject.getUpdaters

getWidth()

getWidth(): number

Defined in: mobjects/text/Text.ts:271

Get text width in world units

Returns

number

Overrides

TexturedMobject.getWidth

hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:1026

Returns

boolean

Inherited from

TexturedMobject.hasUpdaters

isEmpty()

isEmpty(): boolean

Defined in: core/Mobject.ts:611

Whether this mobject has no renderable geometry. Base default is conservative: non-empty unless specialized subclasses decide otherwise.

Returns

boolean

Inherited from

TexturedMobject.isEmpty

isTransformNormalized()

isTransformNormalized(): boolean

Defined in: core/Mobject.ts:517

Check if this mobject's transform is normalized (rotation=0, scale=1).

Returns

boolean

Post

result === (rotation.x==0 && rotation.y==0 && rotation.z==0 && scaleVector===[1,1,1])

Inherited from

TexturedMobject.isTransformNormalized

loadGlyphs()

loadGlyphs(options?): Promise<TextGlyphGroup>

Defined in: mobjects/text/Text.ts:607

Lazily create a TextGlyphGroup from the font file at _fontUrl. Returns null if no fontUrl was provided.

Parameters

options?

skeletonOptions?

SkeletonizeOptions

Fine-tuning options for the skeletonization algorithm (grid resolution, smoothing, etc.).

useSkeletonStroke?

boolean

When true, each glyph computes its skeleton (medial axis) for center-line stroke animation. Default: false.

Returns

Promise<TextGlyphGroup>

moveTo()

moveTo(target, alignedEdge?): this

Defined in: core/Mobject.ts:256

Move to target position in world space.

Computes the delta from the current world-space center, converts it into this node's parent-local frame (the frame shift()/position live in), and applies it so the world-space center lands on the target. The parent-local conversion is what makes this correct when the node is parented under a scaled/rotated parent — a raw world delta fed to shift() would be scaled/rotated by the parent. For an unparented node the conversion is the identity, so behavior is unchanged.

Parameters

target

alignedEdge?

Returns

this

Post

result world center === target (within the parent's representable frame)

Pre

!this.isEmpty() if needed (e.g., VGroup).

Inherited from

TexturedMobject.moveTo

moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:723

Parameters

target

alignedEdge?

Returns

this

Inherited from

TexturedMobject.moveToAligned

nextTo()

nextTo(target, direction, buff): this

Defined in: core/Mobject.ts:696

Parameters

target

direction

Vector3Tuple = RIGHT

buff

number = 0.25

Returns

this

Inherited from

TexturedMobject.nextTo

normalizeTransform()

normalizeTransform(worldMatrix): this

Defined in: core/TexturedMobject.ts:50

Flatten a textured leaf. Its geometry is a Three.js display mesh, not bakeable points, so — like Mobject3D — it absolutizes rather than resetting to identity: the local transform is set equal to the incoming world matrix and re-applied to the mesh on every _syncToThree. Keeping the scale on scaleVector (instead of folding it into the plane size and resetting, as #417 had to) is inherently durable across async load / canvas re-render, since those rebuild the geometry but not the Mobject transform.

Parameters

worldMatrix

Matrix4 = ...

Returns

this

Post

old.getBounds() === this.getBounds() // world geometry preserved

Inherited from

TexturedMobject.normalizeTransform

prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:1084

Parameters

numPieces

number = 50

Returns

this

Inherited from

TexturedMobject.prepareForNonlinearTransform

remove()

remove(...mobjects): this

Defined in: core/Mobject.ts:496

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

TexturedMobject.remove

removeUpdater()

removeUpdater(updater): this

Defined in: core/Mobject.ts:1016

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

TexturedMobject.removeUpdater

replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:597

Parameters

target

stretch

boolean = false

Returns

this

Inherited from

TexturedMobject.replace

restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:1101

Returns

boolean

Inherited from

TexturedMobject.restoreState

rotate()

rotate(angle, axisOrOptions?): this

Defined in: core/Mobject.ts:306

Rotate the mobject by angle around an axis. Accepts aboutPoint or aboutEdge to specify the rotation center.

Parameters

angle

number

axisOrOptions?

Vector3Tuple | AxisOrOptions

Returns

this

Inherited from

TexturedMobject.rotate

rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:344

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

TexturedMobject.rotateAboutOrigin

saveState()

saveState(): this

Defined in: core/Mobject.ts:1096

Returns

this

Inherited from

TexturedMobject.saveState

scale()

scale(factor, options?): this

Defined in: core/Mobject.ts:429

Parameters

factor

number | Vector3Tuple

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.scale

setColor()

setColor(color): this

Defined in: core/Mobject.ts:166

Parameters

color

string

Returns

this

Inherited from

TexturedMobject.setColor

setFill()

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:204

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

TexturedMobject.setFill

setFillOpacity()

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:194

Parameters

opacity

number

Returns

this

Inherited from

TexturedMobject.setFillOpacity

setFontFamily()

setFontFamily(family): this

Defined in: mobjects/text/Text.ts:259

Set font family and re-render

Parameters

family

string

CSS font family string

Returns

this

this for chaining

setFontSize()

setFontSize(size): this

Defined in: mobjects/text/Text.ts:238

Set font size and re-render

Parameters

size

number

Font size in points

Returns

this

this for chaining

setStrokeOpacity()

setStrokeOpacity(opacity): this

Defined in: core/Mobject.ts:174

Parameters

opacity

number

Returns

this

Inherited from

TexturedMobject.setStrokeOpacity

setStrokeWidth()

setStrokeWidth(width): this

Defined in: core/Mobject.ts:184

Parameters

width

number

Returns

this

Inherited from

TexturedMobject.setStrokeWidth

setStyle()

setStyle(style): this

Defined in: core/Mobject.ts:152

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

TexturedMobject.setStyle

setText()

setText(text): this

Defined in: mobjects/text/Text.ts:217

Set new text content and re-render

Parameters

text

string

New text to display

Returns

this

this for chaining

setX()

setX(x): this

Defined in: core/Mobject.ts:760

Parameters

x

number

Returns

this

Inherited from

TexturedMobject.setX

setY()

setY(y): this

Defined in: core/Mobject.ts:764

Parameters

y

number

Returns

this

Inherited from

TexturedMobject.setY

setZ()

setZ(z): this

Defined in: core/Mobject.ts:768

Parameters

z

number

Returns

this

Inherited from

TexturedMobject.setZ

shift()

shift(delta): this

Defined in: core/Mobject.ts:234

Parameters

delta

Returns

this

Inherited from

TexturedMobject.shift

stretch()

stretch(factor, dim, options?): this

Defined in: core/Mobject.ts:461

Parameters

factor

number

dim

number

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.stretch

toCorner()

toCorner(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:801

Parameters

direction

Vector3Tuple = ...

buff

number = 0.5

frameDimensions?

[number, number]

Returns

this

Inherited from

TexturedMobject.toCorner

toEdge()

toEdge(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:796

Parameters

direction