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:95
JSON-serializable saved state (used by restoreState()).
Inherited from
MathTexImage.__savedMobjectState
_activeRenderer
protected_activeRenderer:"katex"|"mathjax"=null
Defined in: mobjects/text/MathTexImage.ts:117
Which renderer was actually used for the last successful render
Inherited from
_arrangePromise
protected_arrangePromise:Promise<void> =null
Defined in: mobjects/text/MathTexImage.ts:123
Promise that resolves when parts are arranged (multi-part only)
Inherited from
_color
protected_color:string='#ffffff'
Defined in: core/Mobject.ts:70
Inherited from
_dirty
_dirty:
boolean=true
Defined in: core/Mobject.ts:88
Inherited from
_disableChildZLayering
protected_disableChildZLayering:boolean=false
Defined in: core/Mobject.ts:85
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:112
Inherited from
_fontSize
protected_fontSize:number
Defined in: mobjects/text/MathTexImage.ts:111
Inherited from
_isMultiPart
protected_isMultiPart:boolean=false
Defined in: mobjects/text/MathTexImage.ts:119
Whether this is a multi-part MathTexImage (created from string[])
Inherited from
_latex
protected_latex:string
Defined in: mobjects/text/MathTexImage.ts:110
Inherited from
_opacity
protected_opacity:number=1
Defined in: core/Mobject.ts:81
Inherited from
_padding
protected_padding:number
Defined in: mobjects/text/MathTexImage.ts:125
Padding in pixels around rendered content
Inherited from
_parts
protected_parts:MathTexImage[] =[]
Defined in: mobjects/text/MathTexImage.ts:121
Child MathTexImage parts (only when _isMultiPart is true)
Inherited from
_renderer
protected_renderer:TexRenderer
Defined in: mobjects/text/MathTexImage.ts:115
User-requested renderer mode
Inherited from
_renderState
protected_renderState:RenderState
Defined in: mobjects/text/MathTexImage.ts:113
Inherited from
_style
protected_style:MobjectStyle
Defined in: core/Mobject.ts:86
Inherited from
_threeObject
_threeObject:
Object3D<Object3DEventMap> =null
Defined in: core/Mobject.ts:87
Inherited from
children
children:
Mobject[] =[]
Defined in: core/Mobject.ts:65
Inherited from
createdAtBeginning
createdAtBeginning:
boolean=false
Defined in: core/Mobject.ts:69
Inherited from
MathTexImage.createdAtBeginning
fillOpacity
fillOpacity:
number=0
Defined in: core/Mobject.ts:83
Inherited from
id
readonlyid:string
Defined in: core/Mobject.ts:63
Inherited from
parent
parent:
Mobject=null
Defined in: core/Mobject.ts:64
Inherited from
position
position:
Vector3
Defined in: core/Mobject.ts:66
Inherited from
rotation
rotation:
Euler
Defined in: core/Mobject.ts:67
Inherited from
savedState
savedState:
Mobject=null
Defined in: core/Mobject.ts:91
Saved mobject copy (used by Restore animation). Set by saveState().
Inherited from
scaleVector
scaleVector:
Vector3
Defined in: core/Mobject.ts:68
Inherited from
strokeWidth
strokeWidth:
number=4
Defined in: core/Mobject.ts:82
Inherited from
targetCopy
targetCopy:
Mobject=null
Defined in: core/Mobject.ts:93
Target copy used by generateTarget() / MoveToTarget animation.
Inherited from
Accessors
animate
Get Signature
get animate():
any
Defined in: core/Mobject.ts:497
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
any
Inherited from
color
Get Signature
get color():
string
Defined in: core/Mobject.ts:71
Returns
string
Set Signature
set color(
value):void
Defined in: core/Mobject.ts:74
Parameters
value
string
Returns
void
Inherited from
fillColor
Get Signature
get fillColor():
string
Defined in: core/Mobject.ts:184
Returns
string
Set Signature
set fillColor(
color):void
Defined in: core/Mobject.ts:188
Parameters
color
string
Returns
void
Inherited from
isDirty
Get Signature
get isDirty():
boolean
Defined in: core/Mobject.ts:551
Returns
boolean
Inherited from
opacity
Get Signature
get opacity():
number
Defined in: core/Mobject.ts:114
Returns
number
Set Signature
set opacity(
value):void
Defined in: core/Mobject.ts:118
Parameters
value
number
Returns
void
Inherited from
strokeColor
Get Signature
get strokeColor():
string
Defined in: core/Mobject.ts:195
Returns
string
Set Signature
set strokeColor(
color):void
Defined in: core/Mobject.ts:199
Parameters
color
string
Returns
void
Inherited from
style
Get Signature
get style():
MobjectStyle
Defined in: core/Mobject.ts:122
Returns
Inherited from
submobjects
Get Signature
get submobjects():
Mobject[]
Defined in: core/Mobject.ts:136
Returns
Mobject[]
Inherited from
Methods
_createCopy()
protected_createCopy():MathTexImage
Defined in: mobjects/text/MathTexImage.ts:1090
Create a copy of this MathTexImage
Returns
Inherited from
_createThreeObject()
protected_createThreeObject():Object3D
Defined in: mobjects/text/MathTexImage.ts:966
Create the Three.js backing object
Returns
Object3D
Inherited from
MathTexImage._createThreeObject
_getBoundingBox()
_getBoundingBox():
object
Defined in: core/Mobject.ts:449
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:442
Parameters
direction
Returns
Inherited from
MathTexImage._getEdgeInDirection
_handoffTextureMap()
protected_handoffTextureMap(material,nextTexture,previousTexture):void
Defined in: core/TexturedMobject.ts:42
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
_markDirty()
_markDirty():
void
Defined in: core/Mobject.ts:541
Returns
void
Inherited from
_markDirtyUpward()
_markDirtyUpward():
void
Defined in: core/Mobject.ts:545
Returns
void
Inherited from
_renderDomToCanvas()
protected_renderDomToCanvas(container,containerRect,width,height,padding,scale):Promise<HTMLCanvasElement>
Defined in: mobjects/text/MathTexImage.ts:721
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:441
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:600
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:484
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
_startRender()
protected_startRender():void
Defined in: mobjects/text/MathTexImage.ts:418
Start the async rendering process
Returns
void
Inherited from
_syncMaterialToThree()
protected_syncMaterialToThree():void
Defined in: mobjects/text/MathTexImage.ts:1066
Sync material properties to Three.js
Returns
void
Inherited from
MathTexImage._syncMaterialToThree
_syncToThree()
_syncToThree():
void
Defined in: core/Mobject.ts:519
Returns
void
Inherited from
_updateMeshGeometry()
protected_updateMeshGeometry():void
Defined in: mobjects/text/MathTexImage.ts:952
Update the mesh geometry to match current dimensions
Returns
void
Inherited from
MathTexImage._updateMeshGeometry
add()
add(...
mobjects):this
Defined in: core/Mobject.ts:329
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
addUpdater()
addUpdater(
updater,callOnAdd):this
Defined in: core/Mobject.ts:589
Parameters
updater
callOnAdd
boolean = false
Returns
this
Inherited from
alignTo()
alignTo(
target,direction):this
Defined in: core/Mobject.ts:427
Parameters
target
direction
Returns
this
Inherited from
applyContentFrom()
applyContentFrom(
other):void
Defined in: mobjects/text/MathTexImage.ts:1056
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:619
Parameters
fn
(point) => number[]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
applyMatrix()
applyMatrix(
matrix,options?):this
Defined in: core/Mobject.ts:627
Parameters
matrix
number[][]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
applyTextureFrom()
applyTextureFrom(
other):void
Defined in: mobjects/text/MathTexImage.ts:1018
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:577
Parameters
func
(mobject) => void
Returns
this
Inherited from
applyVisualSize()
applyVisualSize(
width,height):void
Defined in: mobjects/text/MathTexImage.ts:1044
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:376
Parameters
other
Returns
this
Inherited from
center()
center():
this
Defined in: core/Mobject.ts:479
Returns
this
Inherited from
clearUpdaters()
clearUpdaters():
this
Defined in: core/Mobject.ts:601
Returns
this
Inherited from
copy()
copy():
Mobject
Defined in: core/Mobject.ts:358
Returns
Inherited from
dispose()
dispose():
void
Defined in: mobjects/text/MathTexImage.ts:1149
Clean up Three.js resources
Returns
void
Inherited from
flip()
flip(
axis,options?):this
Defined in: core/Mobject.ts:257
Parameters
axis
Vector3Tuple = ...
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
generateTarget()
generateTarget():
Mobject
Defined in: core/Mobject.ts:642
Returns
Inherited from
getActiveRenderer()
getActiveRenderer():
"katex"|"mathjax"
Defined in: mobjects/text/MathTexImage.ts:208
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:458
Returns
Inherited from
getBoundingBox()
getBoundingBox():
object
Defined in: core/Mobject.ts:445
Returns
object
depth
depth:
number
height
height:
number
width
width:
number
Inherited from
getBounds()
getBounds():
object
Defined in: core/Mobject.ts:392
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
Inherited from
getCenter()
getCenter():
Vector3Tuple
Defined in: mobjects/text/MathTexImage.ts:1142
Get the center of this MathTexImage
Returns
Inherited from
getDimensions()
getDimensions(): [
number,number]
Defined in: mobjects/text/MathTexImage.ts:406
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:1002
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:996
Return how many display meshes this textured mobject contributes.
Returns
number
Inherited from
MathTexImage.getDisplayMeshLength
getEdge()
getEdge(
direction):Vector3Tuple
Defined in: core/Mobject.ts:452
Parameters
direction
Returns
Inherited from
getFamily()
getFamily():
Mobject[]
Defined in: core/Mobject.ts:583
Returns
Mobject[]
Inherited from
getFontSize()
getFontSize():
number
Defined in: mobjects/text/MathTexImage.ts:246
Get the font size
Returns
number
Inherited from
getLatex()
getLatex():
string
Defined in: mobjects/text/MathTexImage.ts:227
Get the LaTeX string
Returns
string
Inherited from
getLeft()
getLeft():
Vector3Tuple
Defined in: core/Mobject.ts:461
Returns
Inherited from
getPart()
getPart(
index):MathTexImage
Defined in: mobjects/text/MathTexImage.ts:321
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:336
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:200
Get the renderer mode
Returns
Inherited from
getRight()
getRight():
Vector3Tuple
Defined in: core/Mobject.ts:464
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:555
Returns
Object3D
Inherited from
getTop()
getTop():
Vector3Tuple
Defined in: core/Mobject.ts:455
Returns
Inherited from
getUpdaters()
getUpdaters():
UpdaterFunction[]
Defined in: core/Mobject.ts:608
Returns
Inherited from
hasUpdaters()
hasUpdaters():
boolean
Defined in: core/Mobject.ts:605
Returns
boolean
Inherited from
isRendering()
isRendering():
boolean
Defined in: mobjects/text/MathTexImage.ts:398
Check if rendering is in progress
Returns
boolean
Inherited from
moveTo()
moveTo(
target,alignedEdge?):this
Defined in: core/Mobject.ts:216
Parameters
target
alignedEdge?
Returns
this
Inherited from
moveToAligned()
moveToAligned(
target,alignedEdge?):this
Defined in: core/Mobject.ts:437
Parameters
target
alignedEdge?
Returns
this
Inherited from
nextTo()
nextTo(
target,direction,buff):this
Defined in: core/Mobject.ts:410
Parameters
target
direction
Vector3Tuple = RIGHT
buff
number = 0.25
Returns
this
Inherited from
prepareForNonlinearTransform()
prepareForNonlinearTransform(
numPieces):this
Defined in: core/Mobject.ts:635
Parameters
numPieces
number = 50
Returns
this
Inherited from
MathTexImage.prepareForNonlinearTransform
remove()
remove(...
mobjects):this
Defined in: core/Mobject.ts:342
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
removeUpdater()
removeUpdater(
updater):this
Defined in: core/Mobject.ts:595
Parameters
updater
Returns
this
Inherited from
replace()
replace(
target,stretch):this
Defined in: core/Mobject.ts:381
Parameters
target
stretch
boolean = false
Returns
this
Inherited from
restoreState()
restoreState():
boolean
Defined in: core/Mobject.ts:652
Returns
boolean
Inherited from
rotate()
rotate(
angle,axisOrOptions?):this
Defined in: core/Mobject.ts:237
Rotate the mobject by angle around an axis. Accepts aboutPoint or aboutEdge to specify the rotation center.
Parameters
angle
number
axisOrOptions?
Vector3Tuple | { aboutEdge?: Vector3Tuple; aboutPoint?: Vector3Tuple; axis?: Vector3Tuple; }
Returns
this
Inherited from
rotateAboutOrigin()
rotateAboutOrigin(
angle,axis):this
Defined in: core/Mobject.ts:253
Parameters
angle
number
axis
Vector3Tuple = ...
Returns
this
Inherited from
MathTexImage.rotateAboutOrigin
saveState()
saveState():
this
Defined in: core/Mobject.ts:647
Returns
this
Inherited from
scale()
scale(
factor,options?):this
Defined in: core/Mobject.ts:283
Parameters
factor
number | Vector3Tuple
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
setColor()
setColor(
color):this
Defined in: mobjects/text/MathTexImage.ts:266
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:178
Parameters
color?
string
opacity?
number
Returns
this
Inherited from
setFillOpacity()
setFillOpacity(
opacity):this
Defined in: core/Mobject.ts:168
Parameters
opacity
number
Returns
this
Inherited from
setFontSize()
setFontSize(
size):this
Defined in: mobjects/text/MathTexImage.ts:255
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:236
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:217
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:1106
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:280
Override setStrokeOpacity to propagate to multi-part children.
Parameters
opacity
number
Returns
this
Inherited from
setStrokeWidth()
setStrokeWidth(
width):this
Defined in: core/Mobject.ts:158
Parameters
width
number
Returns
this
Inherited from
setStyle()
setStyle(
style):this
Defined in: core/Mobject.ts:126
Parameters
style
Partial<MobjectStyle>
Returns
this
Inherited from
setX()
setX(
x):this
Defined in: core/Mobject.ts:467
Parameters
x
number
Returns
this
Inherited from
setY()
setY(
y):this
Defined in: core/Mobject.ts:471
Parameters
y
number
Returns
this
Inherited from
setZ()
setZ(
z):this
Defined in: core/Mobject.ts:475
Parameters
z
number
Returns
this
Inherited from
shift()
shift(
delta):this
Defined in: core/Mobject.ts:208
Parameters
delta
Returns
this
Inherited from
stretch()
stretch(
factor,dim,options?):this
Defined in: core/Mobject.ts:310
Parameters
factor
number
dim
number
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
toCorner()
toCorner(
direction,buff,frameDimensions?):this
Defined in: core/Mobject.ts:509
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:504
Parameters
direction
buff
number = 0.5
frameDimensions?
[number, number]
Returns
this
Inherited from
update()
update(
dt):void
Defined in: core/Mobject.ts:612
Parameters
dt
number
Returns
void
Inherited from
waitForRender()
waitForRender():
Promise<void>
Defined in: mobjects/text/MathTexImage.ts:295
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