Class: Text

Returns

this

Inherited from

TexturedMobject._flattenAsContainer

_flattenAsMesh()

protected _flattenAsMesh(worldMatrix): this

Defined in: src/core/Mobject.ts:1035

Flatten a Three.js-mesh node that cannot bake geometry into points: absolutize by setting the local transform equal to worldMatrix, so it renders correctly once its (now identity) ancestors collapse. A mesh is a flattening barrier — its descendants stay relative to it.

Parameters

worldMatrix

Returns

this

Inherited from

TexturedMobject._flattenAsMesh

_getBoundingBox()

_getBoundingBox(): object

Defined in: src/core/Mobject.ts:853

Returns

object

depth

depth: number

height

height: number

width

width: number

Deprecated

Use getBoundingBox() instead.

Inherited from

TexturedMobject._getBoundingBox

_getEdgeInDirection()

_getEdgeInDirection(direction): Vector3Tuple

Defined in: src/core/Mobject.ts:837

Parameters

direction

Returns

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

Inherited from

TexturedMobject._getEdgeInDirection

_handoffTextureMap()

protected _handoffTextureMap(material, nextTexture, previousTexture): void

Defined in: src/core/TexturedMobject.ts:57

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

Parameters

Returns

void

Inherited from

TexturedMobject._handoffTextureMap

_initCanvas()

protected _initCanvas(): void

Defined in: src/mobjects/text/Text.ts:230

Initialize the off-screen canvas

Returns

void

_localToWorld()

protected _localToWorld(p): Vector3Tuple

Defined in: src/core/Mobject.ts:493

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: src/core/Mobject.ts:1093

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: src/core/Mobject.ts:1104

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

_measureStyledText()

protected _measureStyledText(): object

Defined in: src/mobjects/text/Text.ts:550

Measure styled (t2c/t2w/t2s) text via the shared styled-run layout helper.

Returns

object

height

height: number

lines

lines: string[]

width

width: number

_measureText()

protected _measureText(): object

Defined in: src/mobjects/text/Text.ts:361

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: src/core/Mobject.ts:1008

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

Parameters

worldMatrix

Returns

void

Inherited from

TexturedMobject._normalizeChildrenInto

_ownMatrix()

_ownMatrix(): Matrix4

Defined in: src/core/Mobject.ts:1142

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

Returns

Post

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

Post

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

Inherited from

TexturedMobject._ownMatrix

_renderStyledToCanvas()

protected _renderStyledToCanvas(): void

Defined in: src/mobjects/text/Text.ts:561

Render styled (t2c/t2w/t2s) text through the shared styled-run renderer, then store the resulting world-space size.

Returns

void

_renderToCanvas()

protected _renderToCanvas(): void

Defined in: src/mobjects/text/Text.ts:397

Render text to the off-screen canvas

Returns

void

_root()

_root(): Mobject

Defined in: src/core/Mobject.ts:1113

The topmost ancestor (the node with no parent).

Returns

Inherited from

TexturedMobject._root

_rotateAboutParentLocalPoint()

protected _rotateAboutParentLocalPoint(angle, axis, pivotLocal): void

Defined in: src/core/Mobject.ts:462

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

_styledTextParams()

protected _styledTextParams(): StyledTextParams

Defined in: src/mobjects/text/Text.ts:532

Collect the style and layout fields the styled canvas path needs.

Returns

StyledTextParams

_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: src/mobjects/text/Text.ts:705

Sync material properties to Three.js

Returns

void

Overrides

TexturedMobject._syncMaterialToThree

_syncToThree()

_syncToThree(): void

Defined in: src/core/Mobject.ts:1042

Returns

void

Inherited from

TexturedMobject._syncToThree

_syncWorldMatrices()

_syncWorldMatrices(): Object3D

Defined in: src/core/Mobject.ts:769

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: src/mobjects/text/Text.ts:586

Update the mesh geometry to match new dimensions

Returns

void

_usesStyledPath()

protected _usesStyledPath(): boolean

Defined in: src/mobjects/text/Text.ts:286

True when this Text renders through the styled-run canvas path: either a per-substring style map (t2c/t2w/t2s) or an active color gradient is set. Plain Text with none of these keeps the original flat render path.

Returns

boolean

_worldMatrix()

_worldMatrix(): Matrix4

Defined in: src/core/Mobject.ts:1147

Returns

Inherited from

TexturedMobject._worldMatrix

_worldToLocal()

protected _worldToLocal(p): Vector3Tuple

Defined in: src/core/Mobject.ts:503

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: src/core/Mobject.ts:587

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

TexturedMobject.add

addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: src/core/Mobject.ts:1183

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

TexturedMobject.addUpdater

alignTo()

alignTo(target, direction): this

Defined in: src/core/Mobject.ts:821

Parameters

target

direction

Returns

this

Inherited from

TexturedMobject.alignTo

applyContentFrom()

applyContentFrom(other): void

Defined in: src/mobjects/text/Text.ts:679

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: src/core/Mobject.ts:1241

Parameters

fn

(point) => number[]

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.applyFunction

applyFunctionAboutPoint()

applyFunctionAboutPoint(fn, aboutPoint): this

Defined in: src/core/Mobject.ts:1220

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: src/core/Mobject.ts:1249

Parameters

matrix

number[][]

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.applyMatrix

applyTextureFrom()

applyTextureFrom(other): void

Defined in: src/mobjects/text/Text.ts:653

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

Parameters

other

TexturedMobject

Returns

void

Overrides

TexturedMobject.applyTextureFrom

applyToFamily()

applyToFamily(func): this

Defined in: src/core/Mobject.ts:1171

Parameters

func

(mobject) => void

Returns

this

Inherited from

TexturedMobject.applyToFamily

applyVisualSize()

applyVisualSize(width, height): void

Defined in: src/mobjects/text/Text.ts:687

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: src/core/Mobject.ts:700

Parameters

other

Returns

this

Inherited from

TexturedMobject.become

center()

center(): this

Defined in: src/core/Mobject.ts:883

Returns

this

Inherited from

TexturedMobject.center

clearUpdaters()

clearUpdaters(): this

Defined in: src/core/Mobject.ts:1195

Returns

this

Inherited from

TexturedMobject.clearUpdaters

copy()

copy(): Text

Defined in: src/mobjects/text/Text.ts:786

Create a copy of this Text mobject

Returns

Text

Overrides

TexturedMobject.copy

disableChildZLayering()

disableChildZLayering(): this

Defined in: src/core/Mobject.ts:1078

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: src/mobjects/text/Text.ts:840

Clean up Three.js and canvas resources

Returns

void

Overrides

TexturedMobject.dispose

flip()

flip(axis, options?): this

Defined in: src/core/Mobject.ts:509

Parameters

axis

Vector3Tuple = ...

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.flip

generateTarget()

generateTarget(): Mobject

Defined in: src/core/Mobject.ts:1264

Returns

Inherited from

TexturedMobject.generateTarget

getBlendMode()

getBlendMode(): BlendMode

Defined in: src/core/Mobject.ts:243

The current blend mode of this mobject.

Returns

BlendMode

Inherited from

TexturedMobject.getBlendMode

getBottom()

getBottom(): Vector3Tuple

Defined in: src/core/Mobject.ts:862

Returns

Inherited from

TexturedMobject.getBottom

getBoundingBox()

getBoundingBox(): object

Defined in: src/core/Mobject.ts:840

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

TexturedMobject.getBoundingBox

getBounds()

getBounds(): object

Defined in: src/core/Mobject.ts:787

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: src/mobjects/text/Text.ts:779

Get the center of this text mobject

Returns

Overrides

TexturedMobject.getCenter

getDepth()

getDepth(): number

Defined in: src/core/Mobject.ts:849

Returns

number

Inherited from

TexturedMobject.getDepth

getDisplayMeshes()

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

Defined in: src/mobjects/text/Text.ts:641

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: src/mobjects/text/Text.ts:637

Return how many display meshes this textured mobject contributes.

Returns

number

Overrides

TexturedMobject.getDisplayMeshLength

getEdge()

getEdge(direction): Vector3Tuple

Defined in: src/core/Mobject.ts:856

Parameters

direction

Returns

Inherited from

TexturedMobject.getEdge

getFamily()

getFamily(): Mobject[]

Defined in: src/core/Mobject.ts:1177

Returns

Mobject[]

Inherited from

TexturedMobject.getFamily

getFontFamily()

getFontFamily(): string

Defined in: src/mobjects/text/Text.ts:314

Get the current font family

Returns

string

getFontSize()

getFontSize(): number

Defined in: src/mobjects/text/Text.ts:293

Get the current font size

Returns

number

getGlyphGroup()

getGlyphGroup(): TextGlyphGroup

Defined in: src/mobjects/text/Text.ts:722

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

Returns

TextGlyphGroup

getGradient()

getGradient(): string[]

Defined in: src/mobjects/text/Text.ts:277

Get the configured linear gradient colors, or null when the fill is flat. Returns a copy so callers cannot mutate the internal state.

Returns

string[]

getHeight()

getHeight(): number

Defined in: src/mobjects/text/Text.ts:342

Get text height in world units

Returns

number

Overrides

TexturedMobject.getHeight

getLeft()

getLeft(): Vector3Tuple

Defined in: src/core/Mobject.ts:865

Returns

Inherited from

TexturedMobject.getLeft

getLocalCenter()

getLocalCenter(): Vector3Tuple

Defined in: src/core/Mobject.ts:751

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: src/core/Mobject.ts:868

Returns

Inherited from

TexturedMobject.getRight

getStyledTextLines()

getStyledTextLines(): TextStyleRun[][]

Defined in: src/mobjects/text/Text.ts:269

Get the per-substring style layout model: lines of styled runs.

This is the testable model behind t2c/t2w/t2s. A run's null fields fall back to the Text base color/weight/style at render time.

Returns

TextStyleRun[][]

getText()

getText(): string

Defined in: src/mobjects/text/Text.ts:245

Get the current text content

Returns

string

getTextureMesh()

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

Defined in: src/mobjects/text/Text.ts:772

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

Returns

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

getThreeObject()

getThreeObject(): Object3D

Defined in: src/core/Mobject.ts:1117

Returns

Object3D

Inherited from

TexturedMobject.getThreeObject

getTop()

getTop(): Vector3Tuple

Defined in: src/core/Mobject.ts:859

Returns

Inherited from

TexturedMobject.getTop

getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: src/core/Mobject.ts:1202

Returns

UpdaterFunction[]

Inherited from

TexturedMobject.getUpdaters

getWidth()

getWidth(): number

Defined in: src/mobjects/text/Text.ts:335

Get text width in world units

Returns

number

Overrides

TexturedMobject.getWidth

hasUpdaters()

hasUpdaters(): boolean

Defined in: src/core/Mobject.ts:1199

Returns

boolean

Inherited from

TexturedMobject.hasUpdaters

isEmpty()

isEmpty(): boolean

Defined in: src/core/Mobject.ts:719

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: src/core/Mobject.ts:623

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: src/mobjects/text/Text.ts:735

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>

matchDepth()

matchDepth(mob): this

Defined in: src/core/Mobject.ts:932

Scale uniformly so the depth matches mob's depth.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchDepth

matchHeight()

matchHeight(mob): this

Defined in: src/core/Mobject.ts:928

Scale uniformly so the height matches mob's height.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchHeight

matchWidth()

matchWidth(mob): this

Defined in: src/core/Mobject.ts:924

Scale uniformly so the width matches mob's width.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchWidth

matchX()

matchX(mob): this

Defined in: src/core/Mobject.ts:936

Shift so the center x-coordinate matches mob's.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchX

matchY()

matchY(mob): this

Defined in: src/core/Mobject.ts:940

Shift so the center y-coordinate matches mob's.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchY

matchZ()

matchZ(mob): this

Defined in: src/core/Mobject.ts:944

Shift so the center z-coordinate matches mob's.

Parameters

mob

Returns

this

Inherited from

TexturedMobject.matchZ

moveTo()

moveTo(target, alignedEdge?): this

Defined in: src/core/Mobject.ts:362

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: src/core/Mobject.ts:831

Parameters

target

alignedEdge?

Returns

this

Inherited from

TexturedMobject.moveToAligned

nextTo()

nextTo(target, direction, buff): this

Defined in: src/core/Mobject.ts:804

Parameters

target

direction

Vector3Tuple = RIGHT

buff

number = 0.25

Returns

this

Inherited from

TexturedMobject.nextTo

normalizeTransform()

normalizeTransform(worldMatrix): this

Defined in: src/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: src/core/Mobject.ts:1257

Parameters

numPieces

number = 50

Returns

this

Inherited from

TexturedMobject.prepareForNonlinearTransform

remove()

remove(...mobjects): this

Defined in: src/core/Mobject.ts:602

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

TexturedMobject.remove

removeUpdater()

removeUpdater(updater): this

Defined in: src/core/Mobject.ts:1189

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

TexturedMobject.removeUpdater

replace()

replace(target, stretch): this

Defined in: src/core/Mobject.ts:705

Parameters

target

stretch

boolean = false

Returns

this

Inherited from

TexturedMobject.replace

restoreState()

restoreState(): boolean

Defined in: src/core/Mobject.ts:1274

Returns

boolean

Inherited from

TexturedMobject.restoreState

rotate()

rotate(angle, axisOrOptions?): this

Defined in: src/core/Mobject.ts:412

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: src/core/Mobject.ts:450

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

TexturedMobject.rotateAboutOrigin

saveState()

saveState(): this

Defined in: src/core/Mobject.ts:1269

Returns

this

Inherited from

TexturedMobject.saveState

scale()

scale(factor, options?): this

Defined in: src/core/Mobject.ts:535

Parameters

factor

number | Vector3Tuple

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.scale

scaleToFitDepth()

scaleToFitDepth(depth): this

Defined in: src/core/Mobject.ts:906

Scale uniformly so the depth becomes depth.

Parameters

depth

number

Returns

this

Inherited from

TexturedMobject.scaleToFitDepth

scaleToFitHeight()

scaleToFitHeight(height): this

Defined in: src/core/Mobject.ts:900

Scale uniformly so the height becomes height.

Parameters

height

number

Returns

this

Inherited from

TexturedMobject.scaleToFitHeight

scaleToFitWidth()

scaleToFitWidth(width): this

Defined in: src/core/Mobject.ts:894

Scale uniformly so the width becomes width.

Parameters

width

number

Returns

this

Inherited from

TexturedMobject.scaleToFitWidth

setBlendMode()

setBlendMode(mode): this

Defined in: src/core/Mobject.ts:233

Set the blend mode for this mobject and its whole family.

The mode flows through to every three.js material of this mobject and its submobjects on the next sync. The default is 'normal' (standard alpha blending), which matches three.js's own default, so output is unchanged until a non-default mode is set.

Parameters

mode

BlendMode

One of normal, additive, multiply, subtractive, screen.

Returns

this

this for chaining.

Inherited from

TexturedMobject.setBlendMode

setColor()

setColor(color): this

Defined in: src/core/Mobject.ts:212

Parameters

color

string

Returns

this

Inherited from

TexturedMobject.setColor

setDepth()

setDepth(depth): this

Defined in: src/core/Mobject.ts:920

CE set_depth (stretch=false default): alias of scaleToFitDepth.

Parameters

depth

number

Returns

this

Inherited from

TexturedMobject.setDepth

setFill()

setFill(color?, opacity?): this

Defined in: src/core/Mobject.ts:310

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

TexturedMobject.setFill

setFillOpacity()

setFillOpacity(opacity): this

Defined in: src/core/Mobject.ts:300

Parameters

opacity

number

Returns

this

Inherited from

TexturedMobject.setFillOpacity

setFontFamily()

setFontFamily(family): this

Defined in: src/mobjects/text/Text.ts:323

Set font family and re-render

Parameters

family

string

CSS font family string

Returns

this

this for chaining

setFontSize()

setFontSize(size): this

Defined in: src/mobjects/text/Text.ts:302

Set font size and re-render

Parameters

size

number

Font size in points

Returns

this

this for chaining

setHeight()

setHeight(height): this

Defined in: src/core/Mobject.ts:916

CE set_height (stretch=false default): alias of scaleToFitHeight.

Parameters

height

number

Returns

this

Inherited from

TexturedMobject.setHeight

setStrokeOpacity()

setStrokeOpacity(opacity): this

Defined in: src/core/Mobject.ts:280

Parameters

opacity

number

Returns

this

Inherited from

TexturedMobject.setStrokeOpacity

setStrokeWidth()

setStrokeWidth(width): this

Defined in: src/core/Mobject.ts:290

Parameters

width

number

Returns

this

Inherited from

TexturedMobject.setStrokeWidth

setStyle()

setStyle(style): this

Defined in: src/core/Mobject.ts:198

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

TexturedMobject.setStyle

setText()

setText(text): this

Defined in: src/mobjects/text/Text.ts:254

Set new text content and re-render

Parameters

text

string

New text to display

Returns

this

this for chaining

setUserId()

setUserId(userId): this

Defined in: src/core/Mobject.ts:179

Set the user-defined string identifier used by Scene.getMobject. Chainable, so it fits factory and loop code: factory().setUserId('row-3'). The value need not be unique; the lookup returns the first match.

Parameters

userId

string

The identifier to assign

Returns

this

Inherited from

TexturedMobject.setUserId

setWidth()

setWidth(width): this

Defined in: src/core/Mobject.ts:912

CE set_width (stretch=false default): alias of scaleToFitWidth.

Parameters

width

number

Returns

this

Inherited from

TexturedMobject.setWidth

setX()

setX(x): this

Defined in: src/core/Mobject.ts:871

Parameters

x

number

Returns

this

Inherited from

TexturedMobject.setX

setY()

setY(y): this

Defined in: src/core/Mobject.ts:875

Parameters

y

number

Returns

this

Inherited from

TexturedMobject.setY

setZ()

setZ(z): this

Defined in: src/core/Mobject.ts:879

Parameters

z

number

Returns

this

Inherited from

TexturedMobject.setZ

shift()

shift(delta): this

Defined in: src/core/Mobject.ts:340

Parameters

delta

Returns

this

Inherited from

TexturedMobject.shift

stretch()

stretch(factor, dim, options?): this

Defined in: src/core/Mobject.ts:567

Parameters

factor

number

dim

number

options?

aboutEdge?

aboutPoint?

Returns

this

Inherited from

TexturedMobject.stretch

toCorner()

toCorner(direction, buff, frameDimensions?): this

Defined in: src/core/Mobject.ts:973

Parameters

direction

Vector3Tuple = ...

buff

number = 0.5

frameDimensions?

[number, number]

Returns

this

Inherited from

TexturedMobject.toCorner

toEdge()

toEdge(direction, buff, frameDimensions?): this

Defined in: src/core/Mobject.ts:968

Parameters

direction