Class: SingleStringMathTex
Defined in: mobjects/text/MathTexParts.ts:12
SingleStringMathTex - A variant of MathTexImage for single-string LaTeX
Wraps MathTexImage but enforces that the LaTeX is treated as a single indivisible expression (no part splitting).
Extends
Constructors
Constructor
new SingleStringMathTex(
latex,options):SingleStringMathTex
Defined in: mobjects/text/MathTexParts.ts:13
Parameters
latex
string
options
SingleStringMathTexOptions = {}
Returns
SingleStringMathTex
Overrides
Properties
__savedMobjectState
__savedMobjectState:
unknown=null
Defined in: core/Mobject.ts:121
JSON-serializable saved state (used by restoreState()).
Inherited from
MathTexImage.__savedMobjectState
_activeRenderer
protected_activeRenderer:"katex"|"mathjax"=null
Defined in: mobjects/text/MathTexImage.ts:125
Which renderer was actually used for the last successful render
Inherited from
_arrangePromise
protected_arrangePromise:Promise<void> =null
Defined in: mobjects/text/MathTexImage.ts:131
Promise that resolves when parts are arranged (multi-part only)
Inherited from
_color
protected_color:string='#ffffff'
Defined in: core/Mobject.ts:84
Inherited from
_dirty
_dirty:
boolean=true
Defined in: core/Mobject.ts:113
THREE backing object needs re-sync from this node's transform/state.
Inv
this._dirty || child._dirty === false // a clean node has a clean subtree
This invariant is what makes the early-return in _syncToThree() and the root-sync in _syncWorldMatrices() correct. It holds because _markDirty() always propagates upward. Marking a node dirty WITHOUT marking its ancestors (e.g. reverting _markDirty to self-only) silently breaks it: a clean ancestor will short-circuit the sync and never reach the dirty descendant, leaving stale world coordinates (issue #251).
Inherited from
_disableChildZLayering
protected_disableChildZLayering:boolean=false
Defined in: core/Mobject.ts:99
When true, children skip the 2D z-layering offset in _syncToThree.
Inherited from
MathTexImage._disableChildZLayering
_displayMode
protected_displayMode:boolean
Defined in: mobjects/text/MathTexImage.ts:120
Inherited from
_fontSize
protected_fontSize:number
Defined in: mobjects/text/MathTexImage.ts:119
Inherited from
_isMultiPart
protected_isMultiPart:boolean=false
Defined in: mobjects/text/MathTexImage.ts:127
Whether this is a multi-part MathTexImage (created from string[])
Inherited from
_isVMobject
_isVMobject:
boolean=false
Defined in: core/Mobject.ts:114
Inherited from
_latex
protected_latex:string
Defined in: mobjects/text/MathTexImage.ts:118
Inherited from
_opacity
protected_opacity:number=1
Defined in: core/Mobject.ts:95
Inherited from
_padding
protected_padding:number
Defined in: mobjects/text/MathTexImage.ts:133
Padding in pixels around rendered content
Inherited from
_parts
protected_parts:MathTexImage[] =[]
Defined in: mobjects/text/MathTexImage.ts:129
Child MathTexImage parts (only when _isMultiPart is true)
Inherited from
_renderer
protected_renderer:TexRenderer
Defined in: mobjects/text/MathTexImage.ts:123
User-requested renderer mode
Inherited from
_renderState
protected_renderState:RenderState
Defined in: mobjects/text/MathTexImage.ts:121
Inherited from
_style
protected_style:MobjectStyle
Defined in: core/Mobject.ts:100
Inherited from
_threeObject
_threeObject:
Object3D<Object3DEventMap> =null
Defined in: core/Mobject.ts:101
Inherited from
_visualSizeOverride
protected_visualSizeOverride: [number,number] =null
Defined in: mobjects/text/MathTexImage.ts:143
Base plane size [width, height] (render units) that a copy() of an
already-rendered MathTexImage must reproduce, overriding the natural size the
copy's fresh async re-render measures. Set by _createCopy from the source's
current _renderState size; applied once in _startRender's post-render
callback and then cleared. (Any transform scale is carried separately on
scaleVector by _copyBaseAttributesInto.) Null for normal (non-copy)
instances, so the standard render/reveal path is untouched.
Inherited from
MathTexImage._visualSizeOverride
children
children:
Mobject[] =[]
Defined in: core/Mobject.ts:79
Inherited from
createdAtBeginning
createdAtBeginning:
boolean=false
Defined in: core/Mobject.ts:83
Inherited from
MathTexImage.createdAtBeginning
fillOpacity
fillOpacity:
number=0
Defined in: core/Mobject.ts:97
Inherited from
id
readonlyid:string
Defined in: core/Mobject.ts:77
Inherited from
parent
parent:
Mobject=null
Defined in: core/Mobject.ts:78
Inherited from
position
position:
Vector3
Defined in: core/Mobject.ts:80
Inherited from
rotation
rotation:
Euler
Defined in: core/Mobject.ts:81
Inherited from
savedState
savedState:
Mobject=null
Defined in: core/Mobject.ts:117
Saved mobject copy (used by Restore animation). Set by saveState().
Inherited from
scaleVector
scaleVector:
Vector3
Defined in: core/Mobject.ts:82
Inherited from
strokeWidth
strokeWidth:
number=4
Defined in: core/Mobject.ts:96
Inherited from
targetCopy
targetCopy:
Mobject=null
Defined in: core/Mobject.ts:119
Target copy used by generateTarget() / MoveToTarget animation.
Inherited from
Accessors
animate
Get Signature
get animate():
AnimateProxy
Defined in: core/Mobject.ts:789
Returns an AnimateProxy that records method calls.
Pass the proxy to scene.play() to animate from the current state
to the state after all recorded calls are applied.
Example
scene.play(circle.animate.shift([2, 0, 0]));
scene.play(circle.animate.setColor('#ff0000').scale(2));
Returns
Inherited from
color
Get Signature
get color():
string
Defined in: core/Mobject.ts:85
Returns
string
Set Signature
set color(
value):void
Defined in: core/Mobject.ts:88
Parameters
value
string
Returns
void
Inherited from
fillColor
Get Signature
get fillColor():
string
Defined in: core/Mobject.ts:210
Returns
string
Set Signature
set fillColor(
color):void
Defined in: core/Mobject.ts:214
Parameters
color
string
Returns
void
Inherited from
isDirty
Get Signature
get isDirty():
boolean
Defined in: core/Mobject.ts:935
Returns
boolean
Inherited from
opacity
Get Signature
get opacity():
number
Defined in: core/Mobject.ts:140
Returns
number
Set Signature
set opacity(
value):void
Defined in: core/Mobject.ts:144
Parameters
value
number
Returns
void
Inherited from
strokeColor
Get Signature
get strokeColor():
string
Defined in: core/Mobject.ts:221
Returns
string
Set Signature
set strokeColor(
color):void
Defined in: core/Mobject.ts:225
Parameters
color
string
Returns
void
Inherited from
style
Get Signature
get style():
MobjectStyle
Defined in: core/Mobject.ts:148
Returns
Inherited from
submobjects
Get Signature
get submobjects():
Mobject[]
Defined in: core/Mobject.ts:162
Returns
Mobject[]
Inherited from
Methods
_applyFunctionAboutPoint()
protected_applyFunctionAboutPoint(_fn,_aboutPoint):void
Defined in: core/Mobject.ts:1063
Per-node hook called by applyFunctionAboutPoint.
Parameters
_fn
(pts) => number[][]
_aboutPoint
number[]
Returns
void
Pre
fn(pts).length === pts.length
Post
getPoints()[i] === fn(old.getPoints())[i]
Note
no-op in base Mobject; override in subclasses with own points
Inherited from
MathTexImage._applyFunctionAboutPoint
_createThreeObject()
protected_createThreeObject():Object3D
Defined in: mobjects/text/MathTexImage.ts:1017
Create the Three.js backing object
Returns
Object3D
Inherited from
MathTexImage._createThreeObject
_flattenAsContainer()
protected_flattenAsContainer(worldMatrix):this
Defined in: core/Mobject.ts:848
Flatten a node whose geometry is fully described by its children (or which
has no own geometry): recurse into children, then reset own transform to
identity. The transform is not lost — it was folded into the descendants via
the composed worldMatrix.
Parameters
worldMatrix
Matrix4
Returns
this
Inherited from
MathTexImage._flattenAsContainer
_flattenAsMesh()
protected_flattenAsMesh(worldMatrix):this
Defined in: core/Mobject.ts:863
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
Matrix4
Returns
this
Inherited from
_getBoundingBox()
_getBoundingBox():
object
Defined in: core/Mobject.ts:742
Returns
object
depth
depth:
number
height
height:
number
width
width:
number
Deprecated
Use getBoundingBox() instead.
Inherited from
_getEdgeInDirection()
_getEdgeInDirection(
direction):Vector3Tuple
Defined in: core/Mobject.ts:729
Parameters
direction
Returns
World-space edge position (center + half-bounding-box offset).
Inherited from
MathTexImage._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
MathTexImage._handoffTextureMap
_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
_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
_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
_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
MathTexImage._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
_renderDomToCanvas()
protected_renderDomToCanvas(container,containerRect,width,height,padding,scale):Promise<HTMLCanvasElement>
Defined in: mobjects/text/MathTexImage.ts:763
Walk the KaTeX DOM tree and render text nodes + SVG elements at their computed CSS positions onto a canvas.
Parameters
container
HTMLElement
containerRect
DOMRect
width
number
height
number
padding
number
scale
number = 2
Returns
Promise<HTMLCanvasElement>
Inherited from
MathTexImage._renderDomToCanvas
_renderLatex()
protected_renderLatex():Promise<void>
Defined in: mobjects/text/MathTexImage.ts:467
Render the LaTeX to a canvas using the selected renderer.
Renderer selection logic:
- 'katex' : Use KaTeX directly (throwOnError: false)
- 'mathjax': Use MathJax SVG output, rendered to canvas via Image
- 'auto' : Try KaTeX with throwOnError: true. If it throws, fall back to MathJax.
Returns
Promise<void>
Inherited from
_renderLatexViaKaTeX()
protected_renderLatexViaKaTeX():Promise<void>
Defined in: mobjects/text/MathTexImage.ts:629
Render the LaTeX to a canvas by walking the KaTeX DOM and drawing each text element at its computed CSS position.
IMPORTANT: The canvas dimensions are in pixel space, rendered at the user's fontSize (e.g., fontSize=48 → 48px). The caller must convert these pixel dimensions to world space using scaleFactor = 0.01.
Returns
Promise<void>
Inherited from
MathTexImage._renderLatexViaKaTeX
_renderLatexViaMathJax()
protected_renderLatexViaMathJax():Promise<void>
Defined in: mobjects/text/MathTexImage.ts:510
Render using MathJax SVG output. The SVG is painted onto a canvas texture in the same way the KaTeX path works, keeping the visual pipeline consistent.
Returns
Promise<void>
Inherited from
MathTexImage._renderLatexViaMathJax
_root()
_root():
Mobject
Defined in: core/Mobject.ts:940
The topmost ancestor (the node with no parent).
Returns
Inherited from
_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
MathTexImage._rotateAboutParentLocalPoint
_startRender()
protected_startRender():void
Defined in: mobjects/text/MathTexImage.ts:436
Start the async rendering process
Returns
void
Inherited from
_syncMaterialToThree()
protected_syncMaterialToThree():void
Defined in: mobjects/text/MathTexImage.ts:1117
Sync material properties to Three.js
Returns
void
Inherited from
MathTexImage._syncMaterialToThree
_syncToThree()
_syncToThree():
void
Defined in: core/Mobject.ts:870
Returns
void
Inherited from
_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
MathTexImage._syncWorldMatrices
_updateMeshGeometry()
protected_updateMeshGeometry():void
Defined in: mobjects/text/MathTexImage.ts:1003
Update the mesh geometry to match current dimensions
Returns
void
Inherited from
MathTexImage._updateMeshGeometry
_worldMatrix()
_worldMatrix():
Matrix4
Defined in: core/Mobject.ts:974
Returns
Matrix4
Inherited from
_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
add()
add(...
mobjects):this
Defined in: core/Mobject.ts:481
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
addUpdater()
addUpdater(
updater,callOnAdd):this
Defined in: core/Mobject.ts:1010
Parameters
updater
callOnAdd
boolean = false
Returns
this
Inherited from
alignTo()
alignTo(
target,direction):this
Defined in: core/Mobject.ts:713
Parameters
target
direction
Returns
this
Inherited from
applyContentFrom()
applyContentFrom(
other):void
Defined in: mobjects/text/MathTexImage.ts:1107
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
Inherited from
applyFunction()
applyFunction(
fn,options?):this
Defined in: core/Mobject.ts:1068
Parameters
fn
(point) => number[]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
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
MathTexImage.applyFunctionAboutPoint
applyMatrix()
applyMatrix(
matrix,options?):this
Defined in: core/Mobject.ts:1076
Parameters
matrix
number[][]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
applyTextureFrom()
applyTextureFrom(
other):void
Defined in: mobjects/text/MathTexImage.ts:1069
Copy texture/material-relevant state from another textured mobject.
Parameters
other
TexturedMobject
Returns
void
Inherited from
applyToFamily()
applyToFamily(
func):this
Defined in: core/Mobject.ts:998
Parameters
func
(mobject) => void
Returns
this
Inherited from
applyVisualSize()
applyVisualSize(
width,height):void
Defined in: mobjects/text/MathTexImage.ts:1095
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
Inherited from
become()
become(
other):this
Defined in: core/Mobject.ts:592
Parameters
other
Returns
this
Inherited from
center()
center():
this
Defined in: core/Mobject.ts:772
Returns
this
Inherited from
clearUpdaters()
clearUpdaters():
this
Defined in: core/Mobject.ts:1022
Returns
this
Inherited from
copy()
copy():
MathTexImage
Defined in: mobjects/text/MathTexImage.ts:1138
Deep-copy this mobject: position, color, and (for composites) children. Every concrete subclass MUST implement copy() with its own return type. Call _copyBaseAttributesInto to handle standard properties.
Leaf classes: construct new instance, call helper, return. Self-building composites: construct new instance (rebuilds children), call helper, return. Point-morphing classes: construct, call helper, overwrite _points3D, return.
copy() is a LOCAL structural clone: it reproduces this node's own position/rotation/scale (parent-relative) and deep-copies children. It does NOT fold in ancestor transforms — a clone of a node nested under a transformed group carries only the local transform. To get a world-correct clone, normalizeTransform() the tree first (folding ancestors into absolute geometry) so that local === world, then copy. This is why animations flatten with normalizeTransform() before snapshotting via copy().
Returns
Post
typeof result === typeof this (strongly typed, no casts)
Post
old.getPoints()[i] === this.getPoints()[i] // source is never mutated
Inherited from
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
MathTexImage.disableChildZLayering
dispose()
dispose():
void
Defined in: mobjects/text/MathTexImage.ts:1212
Clean up Three.js resources
Returns
void
Inherited from
flip()
flip(
axis,options?):this
Defined in: core/Mobject.ts:403
Parameters
axis
Vector3Tuple = ...
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
generateTarget()
generateTarget():
Mobject
Defined in: core/Mobject.ts:1091
Returns
Inherited from
getActiveRenderer()
getActiveRenderer():
"katex"|"mathjax"
Defined in: mobjects/text/MathTexImage.ts:226
Get which renderer was actually used for the current render. Returns null if not yet rendered.
Returns
"katex" | "mathjax"
Inherited from
MathTexImage.getActiveRenderer
getBottom()
getBottom():
Vector3Tuple
Defined in: core/Mobject.ts:751
Returns
Inherited from
getBoundingBox()
getBoundingBox():
object
Defined in: core/Mobject.ts:732
Returns
object
depth
depth:
number
height
height:
number
width
width:
number
Inherited from
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
getCenter()
getCenter():
Vector3Tuple
Defined in: mobjects/text/MathTexImage.ts:1205
Get the center of this MathTexImage
Returns
Inherited from
getDimensions()
getDimensions(): [
number,number]
Defined in: mobjects/text/MathTexImage.ts:424
Get the rendered dimensions in world units
Returns
[number, number]
[width, height] or [0, 0] if not yet rendered
Inherited from
getDisplayMeshes()
getDisplayMeshes():
Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap>[]
Defined in: mobjects/text/MathTexImage.ts:1053
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>[]
Inherited from
getDisplayMeshLength()
getDisplayMeshLength():
number
Defined in: mobjects/text/MathTexImage.ts:1047
Return how many display meshes this textured mobject contributes.
Returns
number
Inherited from
MathTexImage.getDisplayMeshLength
getEdge()
getEdge(
direction):Vector3Tuple
Defined in: core/Mobject.ts:745
Parameters
direction
Returns
Inherited from
getFamily()
getFamily():
Mobject[]
Defined in: core/Mobject.ts:1004
Returns
Mobject[]
Inherited from
getFontSize()
getFontSize():
number
Defined in: mobjects/text/MathTexImage.ts:264
Get the font size
Returns
number
Inherited from
getHeight()
getHeight():
number
Defined in: core/Mobject.ts:738
Returns
number
Inherited from
getLatex()
getLatex():
string
Defined in: mobjects/text/MathTexImage.ts:245
Get the LaTeX string
Returns
string
Inherited from
getLeft()
getLeft():
Vector3Tuple
Defined in: core/Mobject.ts:754
Returns
Inherited from
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
getPart()
getPart(
index):MathTexImage
Defined in: mobjects/text/MathTexImage.ts:339
Get a sub-part of a multi-part MathTexImage expression. Only available when the MathTexImage was created with a string array.
Parameters
index
number
Zero-based index of the part
Returns
The MathTexImage sub-part at the given index
Inherited from
getPartCount()
getPartCount():
number
Defined in: mobjects/text/MathTexImage.ts:354
Get the number of parts (1 for single-string, N for multi-part).
Returns
number
Inherited from
getRenderer()
getRenderer():
TexRenderer
Defined in: mobjects/text/MathTexImage.ts:218
Get the renderer mode
Returns
Inherited from
getRight()
getRight():
Vector3Tuple
Defined in: core/Mobject.ts:757
Returns
Inherited from
getTexString()
getTexString():
string
Defined in: mobjects/text/MathTexParts.ts:20
Get the LaTeX source string
Returns
string
getThreeObject()
getThreeObject():
Object3D
Defined in: core/Mobject.ts:944
Returns
Object3D
Inherited from
getTop()
getTop():
Vector3Tuple
Defined in: core/Mobject.ts:748
Returns
Inherited from
getUpdaters()
getUpdaters():
UpdaterFunction[]
Defined in: core/Mobject.ts:1029
Returns
Inherited from
getWidth()
getWidth():
number
Defined in: core/Mobject.ts:735
Returns
number
Inherited from
hasUpdaters()
hasUpdaters():
boolean
Defined in: core/Mobject.ts:1026
Returns
boolean
Inherited from
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
isRendering()
isRendering():
boolean
Defined in: mobjects/text/MathTexImage.ts:416
Check if rendering is in progress
Returns
boolean
Inherited from
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
MathTexImage.isTransformNormalized
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
moveToAligned()
moveToAligned(
target,alignedEdge?):this
Defined in: core/Mobject.ts:723
Parameters
target
alignedEdge?
Returns
this
Inherited from
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
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
MathTexImage.normalizeTransform
prepareForNonlinearTransform()
prepareForNonlinearTransform(
numPieces):this
Defined in: core/Mobject.ts:1084
Parameters
numPieces
number = 50
Returns
this
Inherited from
MathTexImage.prepareForNonlinearTransform
remove()
remove(...
mobjects):this
Defined in: core/Mobject.ts:496
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
removeUpdater()
removeUpdater(
updater):this
Defined in: core/Mobject.ts:1016
Parameters
updater
Returns
this
Inherited from
replace()
replace(
target,stretch):this
Defined in: core/Mobject.ts:597
Parameters
target
stretch
boolean = false
Returns
this
Inherited from
restoreState()
restoreState():
boolean
Defined in: core/Mobject.ts:1101
Returns
boolean
Inherited from
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
rotateAboutOrigin()
rotateAboutOrigin(
angle,axis):this
Defined in: core/Mobject.ts:344
Parameters
angle
number
axis
Vector3Tuple = ...
Returns
this
Inherited from
MathTexImage.rotateAboutOrigin
saveState()
saveState():
this
Defined in: core/Mobject.ts:1096
Returns
this
Inherited from
scale()
scale(
factor,options?):this
Defined in: core/Mobject.ts:429
Parameters
factor
number | Vector3Tuple
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
setColor()
setColor(
color):this
Defined in: mobjects/text/MathTexImage.ts:284
Override setColor — texture is always rendered white, so we only need to update the material tint via _syncMaterialToThree (no re-render).
Parameters
color
string
Returns
this
Inherited from
setFill()
setFill(
color?,opacity?):this
Defined in: core/Mobject.ts:204
Parameters
color?
string
opacity?
number
Returns
this
Inherited from
setFillOpacity()
setFillOpacity(
opacity):this
Defined in: core/Mobject.ts:194
Parameters
opacity
number
Returns
this
Inherited from
setFontSize()
setFontSize(
size):this
Defined in: mobjects/text/MathTexImage.ts:273
Set the font size and re-render
Parameters
size
number
New font size in pixels
Returns
this
this for chaining
Inherited from
setLatex()
setLatex(
latex):this
Defined in: mobjects/text/MathTexImage.ts:254
Set the LaTeX string and re-render
Parameters
latex
string
New LaTeX string
Returns
this
this for chaining
Inherited from
setRenderer()
setRenderer(
renderer):this
Defined in: mobjects/text/MathTexImage.ts:235
Set the renderer mode and re-render.
Parameters
renderer
The renderer to use
Returns
this
this for chaining
Inherited from
setRevealProgress()
setRevealProgress(
alpha):void
Defined in: mobjects/text/MathTexImage.ts:1169
Set reveal progress for Write animation (left-to-right wipe).
Parameters
alpha
number
Progress from 0 (hidden) to 1 (fully visible)
Returns
void
Inherited from
MathTexImage.setRevealProgress
setStrokeOpacity()
setStrokeOpacity(
opacity):this
Defined in: mobjects/text/MathTexImage.ts:298
Override setStrokeOpacity to propagate to multi-part children.
Parameters
opacity
number
Returns
this
Inherited from
setStrokeWidth()
setStrokeWidth(
width):this
Defined in: core/Mobject.ts:184
Parameters
width
number
Returns
this
Inherited from
setStyle()
setStyle(
style):this
Defined in: core/Mobject.ts:152
Parameters
style
Partial<MobjectStyle>
Returns
this
Inherited from
setX()
setX(
x):this
Defined in: core/Mobject.ts:760
Parameters
x
number
Returns
this
Inherited from
setY()
setY(
y):this
Defined in: core/Mobject.ts:764
Parameters
y
number
Returns
this
Inherited from
setZ()
setZ(
z):this
Defined in: core/Mobject.ts:768
Parameters
z
number
Returns
this
Inherited from
shift()
shift(
delta):this
Defined in: core/Mobject.ts:234
Parameters
delta
Returns
this
Inherited from
stretch()
stretch(
factor,dim,options?):this
Defined in: core/Mobject.ts:461
Parameters
factor
number
dim
number
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
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
toEdge()
toEdge(
direction,buff,frameDimensions?):this
Defined in: core/Mobject.ts:796
Parameters
direction
buff
number = 0.5
frameDimensions?
[number, number]
Returns
this
Inherited from
update()
update(
dt):void
Defined in: core/Mobject.ts:1033
Parameters
dt
number
Returns
void
Inherited from
waitForRender()
waitForRender():
Promise<void>
Defined in: mobjects/text/MathTexImage.ts:313
Wait for the LaTeX to finish rendering. For multi-part MathTexImage, waits for all parts to render and be arranged.
Returns
Promise<void>
Promise that resolves when rendering is complete