Class: Code
Defined in: mobjects/text/Code.ts:84
Code - A syntax-highlighted code block mobject
Renders code with syntax highlighting using Canvas 2D to a texture. Supports multiple programming languages with customizable color schemes.
Example
// Create Python code block
const pythonCode = new Code({
code: `def hello():
print("Hello, World!")`,
language: 'python',
});
// Create TypeScript code without line numbers
const tsCode = new Code({
code: 'const x: number = 42;',
language: 'typescript',
lineNumbers: false,
});
// Use Monokai color scheme
const monokaiCode = new Code({
code: 'console.log("Hello");',
language: 'javascript',
colorScheme: MONOKAI_COLOR_SCHEME,
});
Extends
Constructors
Constructor
new Code(
options):Code
Defined in: mobjects/text/Code.ts:123
Parameters
options
Returns
Code
Overrides
Properties
__savedMobjectState
__savedMobjectState:
unknown=null
Defined in: core/Mobject.ts:95
JSON-serializable saved state (used by restoreState()).
Inherited from
_backgroundMesh
protected_backgroundMesh:Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap> =null
Defined in: mobjects/text/Code.ts:108
Background mesh
_backgroundPadding
protected_backgroundPadding:number
Defined in: mobjects/text/Code.ts:93
_backgroundRadius
protected_backgroundRadius:number
Defined in: mobjects/text/Code.ts:94
_baseSubpathLengths?
protectedoptional_baseSubpathLengths:number[]
Defined in: core/VMobject.ts:45
Base subpath-length metadata (intrinsic topology, e.g. SVG compound paths).
Inherited from
_canvas
protected_canvas:HTMLCanvasElement=null
Defined in: mobjects/text/Code.ts:98
Off-screen canvas for code rendering
_code
protected_code:string
Defined in: mobjects/text/Code.ts:85
_color
protected_color:string='#ffffff'
Defined in: core/Mobject.ts:70
Inherited from
_colorScheme
protected_colorScheme:CodeColorScheme
Defined in: mobjects/text/Code.ts:91
_ctx
protected_ctx:CanvasRenderingContext2D=null
Defined in: mobjects/text/Code.ts:99
_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
VMobject._disableChildZLayering
_fillMaterial
protected_fillMaterial:MeshBasicMaterial=null
Defined in: core/VMobjectRendering.ts:39
Three.js fill material
Inherited from
_fontFamily
protected_fontFamily:string
Defined in: mobjects/text/Code.ts:90
_fontSize
protected_fontSize:number
Defined in: mobjects/text/Code.ts:89
_geometryDirty
protected_geometryDirty:boolean=true
Defined in: core/VMobjectRendering.ts:42
Whether geometry needs rebuild (separate from material dirty)
Inherited from
_highlightMeshes
protected_highlightMeshes:Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap>[] =[]
Defined in: mobjects/text/Code.ts:121
Highlight rectangles
_language
protected_language:string
Defined in: mobjects/text/Code.ts:86
_lineHeight
protected_lineHeight:number
Defined in: mobjects/text/Code.ts:95
_lineNumbers
protected_lineNumbers:boolean
Defined in: mobjects/text/Code.ts:87
_lines
protected_lines:string[] =[]
Defined in: mobjects/text/Code.ts:115
Parsed lines for later access
_mesh
protected_mesh:Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap> =null
Defined in: mobjects/text/Code.ts:105
Plane mesh for displaying the texture
_opacity
protected_opacity:number=1
Defined in: core/Mobject.ts:81
Inherited from
_points3D
protected_points3D:number[][] =[]
Defined in: core/VMobject.ts:39
Array of cubic Bezier control points in 3D. Each point is [x, y, z]. Stored as: [anchor1, handle1, handle2, anchor2, handle3, handle4, anchor3, ...]
Inherited from
_sceneFrameWidth
_sceneFrameWidth:
number=null
Defined in: core/VMobjectRendering.ts:78
Inherited from
_sceneRendererHeight
_sceneRendererHeight:
number=null
Defined in: core/VMobjectRendering.ts:77
Inherited from
_sceneRendererWidth
_sceneRendererWidth:
number=null
Defined in: core/VMobjectRendering.ts:76
Per-instance renderer context (set by Scene when VMobject is added). When non-null these override the class-level statics so that multiple Scene instances do not corrupt each other's stroke-width calculations.
Inherited from
_showBackground
protected_showBackground:boolean
Defined in: mobjects/text/Code.ts:92
_strokeMaterial
protected_strokeMaterial:LineMaterial=null
Defined in: core/VMobjectRendering.ts:36
Three.js stroke material (Line2 LineMaterial for thick strokes)
Inherited from
_style
protected_style:MobjectStyle
Defined in: core/Mobject.ts:86
Inherited from
_tabWidth
protected_tabWidth:number
Defined in: mobjects/text/Code.ts:88
_texture
protected_texture:CanvasTexture<HTMLCanvasElement> =null
Defined in: mobjects/text/Code.ts:102
Three.js texture from canvas
_threeObject
_threeObject:
Object3D<Object3DEventMap> =null
Defined in: core/Mobject.ts:87
Inherited from
_tokenizedLines
protected_tokenizedLines:Token[][] =[]
Defined in: mobjects/text/Code.ts:118
Tokenized lines for highlighting specific parts
_transformSubpathLengths?
protectedoptional_transformSubpathLengths:number[]
Defined in: core/VMobject.ts:48
Transform-time override for subpath lengths (compound-path metadata).
Inherited from
VMobject._transformSubpathLengths
_visiblePointCount
protected_visiblePointCount:number=null
Defined in: core/VMobject.ts:42
Number of points visible (for Create animation)
Inherited from
_worldHeight
protected_worldHeight:number=0
Defined in: mobjects/text/Code.ts:112
_worldWidth
protected_worldWidth:number=0
Defined in: mobjects/text/Code.ts:111
Cached dimensions in world units
children
children:
Mobject[] =[]
Defined in: core/Mobject.ts:65
Inherited from
createdAtBeginning
createdAtBeginning:
boolean=false
Defined in: core/Mobject.ts:69
Inherited from
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
useStrokeMesh
useStrokeMesh:
boolean=false
Defined in: core/VMobjectRendering.ts:146
When true, render stroke as a mesh ring with miter-joined corners instead of Line2 for closed paths.
Inherited from
_frameWidth
static_frameWidth:number=14
Defined in: core/VMobjectRendering.ts:69
Camera frame width in world units (set by Scene, for stroke width conversion)
Inherited from
_rendererHeight
static_rendererHeight:number=450
Defined in: core/VMobjectRendering.ts:66
Inherited from
_rendererWidth
static_rendererWidth:number=800
Defined in: core/VMobjectRendering.ts:65
Renderer resolution for LineMaterial (set by Scene)
Inherited from
useShaderCurves
staticuseShaderCurves:boolean=false
Defined in: core/VMobjectRendering.ts:131
When true, VMobjects use GPU Bezier SDF shaders for stroke rendering instead of the default Line2/LineMaterial approach.
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
numPoints
Get Signature
get numPoints():
number
Defined in: core/VMobject.ts:115
Get the number of points
Returns
number
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
points
Get Signature
get points():
Point[]
Defined in: core/VMobject.ts:65
Get all points as 2D Point objects (derived from _points3D)
Returns
Point[]
Inherited from
shaderCurves
Get Signature
get shaderCurves():
boolean
Defined in: core/VMobjectRendering.ts:168
Check whether this instance should use shader-based Bezier curve rendering.
Returns
boolean
Set Signature
set shaderCurves(
value):void
Defined in: core/VMobjectRendering.ts:173
Enable or disable shader-based Bezier rendering for this instance.
Parameters
value
boolean
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
visiblePointCount
Get Signature
get visiblePointCount():
number
Defined in: core/VMobject.ts:122
Get the number of visible points (for Create animation)
Returns
number
Set Signature
set visiblePointCount(
count):void
Defined in: core/VMobject.ts:129
Set the number of visible points (for Create animation)
Parameters
count
number
Returns
void
Inherited from
Methods
_buildEarcutFillGeometry()
protected_buildEarcutFillGeometry(points3D):BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>
Defined in: core/VMobjectRendering.ts:204
Parameters
points3D
number[][]
Returns
BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Inherited from
VMobject._buildEarcutFillGeometry
_buildFontString()
protected_buildFontString():string
Defined in: mobjects/text/Code.ts:365
Build the CSS font string
Returns
string
_createCopy()
protected_createCopy():Code
Defined in: mobjects/text/Code.ts:578
Create a copy of this Code mobject
Returns
Code
Overrides
_createThreeObject()
protected_createThreeObject():Object3D
Defined in: mobjects/text/Code.ts:514
Create the Three.js backing object
Returns
Object3D
Overrides
_disposeRenderingResources()
protected_disposeRenderingResources():void
Defined in: core/VMobjectRendering.ts:618
Returns
void
Inherited from
VMobject._disposeRenderingResources
_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
_getLineNumberWidth()
protected_getLineNumberWidth():number
Defined in: mobjects/text/Code.ts:373
Calculate the width needed for line numbers
Returns
number
_initCanvas()
protected_initCanvas():void
Defined in: mobjects/text/Code.ts:167
Initialize the off-screen canvas
Returns
void
_interpolatePointList3D()
protected_interpolatePointList3D(points,targetCount):number[][]
Defined in: core/VMobject.ts:531
Interpolate a 3D point list to have a specific number of points.
Delegates to the bezier-aware resamplePointList3D so that valid cubic
Bezier chains are densified by de Casteljau subdivision rather than
piecewise-linear interpolation. Linear lerp on cubic control points
silently produces invalid handles (handle = midpoint of two adjacent
controls), which renders as flat polygonal segments mid-Transform.
Parameters
points
number[][]
targetCount
number
Returns
number[][]
Inherited from
VMobject._interpolatePointList3D
_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
_measureCode()
protected_measureCode():object
Defined in: mobjects/text/Code.ts:385
Measure canvas dimensions needed
Returns
object
height
height:
number
width
width:
number
_parseCode()
protected_parseCode():void
Defined in: mobjects/text/Code.ts:182
Parse code into lines and tokenize
Returns
void
_pointsToCurvePath()
protected_pointsToCurvePath():CurvePath<Vector3>
Defined in: core/VMobjectRendering.ts:200
Returns
CurvePath<Vector3>
Inherited from
_pointsToShape()
protected_pointsToShape():Shape
Defined in: core/VMobjectRendering.ts:196
Returns
Shape
Inherited from
_renderToCanvas()
protected_renderToCanvas():void
Defined in: mobjects/text/Code.ts:414
Render code to the off-screen canvas
Returns
void
_roundRect()
protected_roundRect(x,y,width,height,radius):void
Defined in: mobjects/text/Code.ts:480
Draw a rounded rectangle
Parameters
x
number
y
number
width
number
height
number
radius
number
Returns
void
_setSceneContext()
_setSceneContext(
rendererWidth,rendererHeight,frameWidth):void
Defined in: core/VMobjectRendering.ts:109
Set per-instance scene context for multi-scene support. Called by Scene when a VMobject is added or the scene is resized.
Parameters
rendererWidth
number
rendererHeight
number
frameWidth
number
Returns
void
Inherited from
_syncMaterialToThree()
protected_syncMaterialToThree():void
Defined in: mobjects/text/Code.ts:556
Sync material properties to Three.js
Returns
void
Overrides
_syncToThree()
_syncToThree():
void
Defined in: core/Mobject.ts:519
Returns
void
Inherited from
_updateGeometry()
protected_updateGeometry(group):void
Defined in: core/VMobjectRendering.ts:248
Update the geometry within the Three.js group.
Parameters
group
Group
Returns
void
Inherited from
_updateMesh()
protected_updateMesh():void
Defined in: mobjects/text/Code.ts:500
Update the mesh geometry to match new dimensions
Returns
void
add()
add(...
mobjects):this
Defined in: core/Mobject.ts:329
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
addPoints()
addPoints(...
points):this
Defined in: core/VMobject.ts:175
Add points to this VMobject using 2D Point objects
Parameters
points
...Point[]
Returns
this
Inherited from
addPointsAsCorners()
addPointsAsCorners(
corners):this
Defined in: core/VMobject.ts:230
Add straight line segments from the last point to each corner. Each corner creates a new cubic Bezier segment with linear handles. Matches Manim's add_points_as_corners.
Parameters
corners
number[][]
Array of [x, y, z] corner points to connect to
Returns
this
this for chaining
Inherited from
addUpdater()
addUpdater(
updater,callOnAdd):this
Defined in: core/Mobject.ts:589
Parameters
updater
callOnAdd
boolean = false
Returns
this
Inherited from
alignPoints()
alignPoints(
target):void
Defined in: core/VMobject.ts:420
Align points between this VMobject and a target so they have the same count, consistent winding, and optimal rotation for smooth morphing.
Parameters
target
The target VMobject to align with
Returns
void
Inherited from
alignTo()
alignTo(
target,direction):this
Defined in: core/Mobject.ts:427
Parameters
target
direction
Returns
this
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
applyToFamily()
applyToFamily(
func):this
Defined in: core/Mobject.ts:577
Parameters
func
(mobject) => void
Returns
this
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
centerPointsAroundPosition()
centerPointsAroundPosition():
this
Defined in: core/VMobject.ts:690
Centers local geometry around the origin and updates position accordingly.
This scans all descendant VMobject points (not only this._points3D), so container-style VMobjects (e.g. MathTex/SVGMobject/CurvesAsSubmobjects) are also centered correctly.
Returns
this
this for chaining
Inherited from
VMobject.centerPointsAroundPosition
clearHighlights()
clearHighlights():
this
Defined in: mobjects/text/Code.ts:350
Clear all line highlights
Returns
this
this for chaining
clearPoints()
clearPoints():
this
Defined in: core/VMobject.ts:264
Clear all points
Returns
this
Inherited from
clearUpdaters()
clearUpdaters():
this
Defined in: core/Mobject.ts:601
Returns
this
Inherited from
copy()
copy():
VMobject
Defined in: core/VMobject.ts:553
Create a copy of this VMobject. Subclasses override _createCopy() to produce an instance of the right concrete type (Circle, Square, etc.), but those constructors typically regenerate points from their own parameters (radius, sideLength, ...). After a Transform animation has morphed the point data, the regenerated points no longer match the actual visual state. We therefore always overwrite the clone's _points3D with the source's current data.
Returns
Inherited from
dispose()
dispose():
void
Defined in: mobjects/text/Code.ts:597
Clean up Three.js and canvas resources
Returns
void
Overrides
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
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/Code.ts:571
Get the center of this code mobject
Returns
Overrides
getCode()
getCode():
string
Defined in: mobjects/text/Code.ts:194
Get the code content
Returns
string
getDisplayMeshes()
getDisplayMeshes():
Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap>[]
Defined in: core/Mobject.ts:569
Returns
Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>[]
Inherited from
getDisplayMeshLength()
getDisplayMeshLength():
number
Defined in: core/Mobject.ts:565
Number of visible display meshes this mobject contributes when rendered. Used for Transform eligibility checks without forcing Three.js object creation.
Returns
number
Inherited from
getEdge()
getEdge(
direction):Vector3Tuple
Defined in: core/Mobject.ts:452
Parameters
direction
Returns
Inherited from
getEffectiveSubpathLengths()
getEffectiveSubpathLengths():
number[]
Defined in: core/VMobject.ts:313
Get effective subpath lengths for rendering. Returns transform override if present, else base/subclass metadata.
Returns
number[]
Inherited from
VMobject.getEffectiveSubpathLengths
getFamily()
getFamily():
Mobject[]
Defined in: core/Mobject.ts:583
Returns
Mobject[]
Inherited from
getHeight()
getHeight():
number
Defined in: mobjects/text/Code.ts:250
Get code height in world units
Returns
number
getLanguage()
getLanguage():
string
Defined in: mobjects/text/Code.ts:215
Get the language
Returns
string
getLeft()
getLeft():
Vector3Tuple
Defined in: core/Mobject.ts:461
Returns
Inherited from
getLineCount()
getLineCount():
number
Defined in: mobjects/text/Code.ts:236
Get the number of lines
Returns
number
getLineOfCode()
getLineOfCode(
lineNumber):object
Defined in: mobjects/text/Code.ts:260
Get a specific line of code as a Text-like mobject representation Returns position info for the specified line
Parameters
lineNumber
number
1-based line number
Returns
object
Object with line info or null if out of range
position
position:
Vector3Tuple
text
text:
string
tokens
tokens:
Token[]
getPoints()
getPoints():
number[][]
Defined in: core/VMobject.ts:108
Get all points defining this VMobject as 3D arrays
Returns
number[][]
Copy of the points array
Inherited from
getRight()
getRight():
Vector3Tuple
Defined in: core/Mobject.ts:464
Returns
Inherited from
getSubpathLengths()
getSubpathLengths():
number[]
Defined in: core/VMobject.ts:290
Get base subpath lengths (intrinsic topology metadata). Subclasses may override this to compute dynamic metadata.
Returns
number[]
Inherited from
getSubpathOrientationSign()
getSubpathOrientationSign(
index):-1|1
Defined in: core/VMobject.ts:353
Get orientation sign for a specific subpath index: +1 (CCW) or -1 (CW).
Parameters
index
number
Returns
-1 | 1
Inherited from
VMobject.getSubpathOrientationSign
getSubpathOrientationSigns()
getSubpathOrientationSigns(
lengths?): (-1|1)[]
Defined in: core/VMobject.ts:324
Get orientation sign for each subpath: +1 (CCW) or -1 (CW). Returns undefined when subpath metadata is missing or inconsistent.
Parameters
lengths?
number[]
Returns
(-1 | 1)[]
Inherited from
VMobject.getSubpathOrientationSigns
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
getUnitVector()
getUnitVector():
Vector3Tuple
Defined in: core/VMobject.ts:587
Get the unit vector from the first to the last point of this VMobject, accounting for the object's current rotation transform.
Returns
Inherited from
getUpdaters()
getUpdaters():
UpdaterFunction[]
Defined in: core/Mobject.ts:608
Returns
Inherited from
getVisiblePointCount()
getVisiblePointCount():
number
Defined in: core/VMobject.ts:164
Get the visible point count (null means all points visible).
Returns
number
Inherited from
getVisiblePoints()
getVisiblePoints():
Point[]
Defined in: core/VMobject.ts:138
Get points that should be visible (for rendering) as 2D Points
Returns
Point[]
Inherited from
getVisiblePoints3D()
getVisiblePoints3D():
number[][]
Defined in: core/VMobject.ts:146
Get points that should be visible (for rendering) as 3D arrays
Returns
number[][]
Inherited from
getWidth()
getWidth():
number
Defined in: mobjects/text/Code.ts:243
Get code width in world units
Returns
number
hasUpdaters()
hasUpdaters():
boolean
Defined in: core/Mobject.ts:605
Returns
boolean
Inherited from
highlightLines()
highlightLines(
startLine,endLine,color):this
Defined in: mobjects/text/Code.ts:290
Highlight a range of lines with a background color
Parameters
startLine
number
Starting line number (1-based)
endLine
number
Ending line number (1-based, inclusive)
color
string = 'rgba(255, 255, 0, 0.3)'
Highlight color. Default: semi-transparent yellow
Returns
this
this for chaining
interpolate()
interpolate(
target,alpha):this
Defined in: core/VMobject.ts:373
Interpolate this VMobject towards a target VMobject
Parameters
target
The target VMobject to interpolate towards
alpha
number
Progress from 0 (this) to 1 (target)
Returns
this
this for chaining
Inherited from
markGeometryDirty()
markGeometryDirty():
void
Defined in: core/VMobjectRendering.ts:180
Mark geometry as needing rebuild on next render.
Returns
void
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
VMobject.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
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
setBaseSubpathLengths()
setBaseSubpathLengths(
lengths):void
Defined in: core/VMobject.ts:280
Set base subpath-length metadata for this VMobject. Represents intrinsic topology (e.g. outer contour + holes from SVG parsing).
Parameters
lengths
number[]
Returns
void
Inherited from
VMobject.setBaseSubpathLengths
setCode()
setCode(
code):this
Defined in: mobjects/text/Code.ts:203
Set new code and re-render
Parameters
code
string
New code to display
Returns
this
this for chaining
setColor()
setColor(
color):this
Defined in: core/Mobject.ts:140
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
setLanguage()
setLanguage(
language):this
Defined in: mobjects/text/Code.ts:224
Set language and re-render
Parameters
language
string
Programming language
Returns
this
this for chaining
setPoints()
setPoints(
points):this
Defined in: core/VMobject.ts:75
Set the points defining this VMobject. Accepts either Point[] ({x, y} objects) or number[][] ([x, y, z] arrays).
Parameters
points
Array of points in either format
number[][] | Point[]
Returns
this
this for chaining
Inherited from
setPoints3D()
setPoints3D(
points):this
Defined in: core/VMobject.ts:100
Set the points defining this VMobject using 3D arrays (alias for setPoints with number[][])
Parameters
points
number[][]
Array of [x, y, z] control points for cubic Bezier curves
Returns
this
this for chaining
Inherited from
setPointsAsCorners()
setPointsAsCorners(
corners):this
Defined in: core/VMobject.ts:189
Set the points to form straight line segments between corner points. Each pair of consecutive corners becomes a cubic Bezier with linear handles. Matches Manim's set_points_as_corners.
Parameters
corners
number[][]
Array of [x, y, z] corner points
Returns
this
this for chaining
Inherited from
setStrokeOpacity()
setStrokeOpacity(
opacity):this
Defined in: core/Mobject.ts:148
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
setTransformSubpathLengths()
setTransformSubpathLengths(
lengths):void
Defined in: core/VMobject.ts:299
Set transform-time subpath lengths override. Used by Transform animations to preserve compound-path structure.
Parameters
lengths
number[]
Array of subpath lengths, or undefined to clear
Returns
void
Inherited from
VMobject.setTransformSubpathLengths
setVisiblePointCount()
setVisiblePointCount(
count):void
Defined in: core/VMobject.ts:155
Set visible point count for progressive creation animations. Use null to show all points.
Parameters
count
number
Returns
void
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
_toLinewidth()
static_toLinewidth(this,strokeWidth):number
Defined in: core/VMobjectRendering.ts:123
Convert Manim-compatible strokeWidth to LineMaterial linewidth in pixels. Python Manim uses cairo_line_width_multiple=0.01, so: linewidth_px = strokeWidth * 0.01 * (rendererWidth / frameWidth)
NOTE: This static method uses class-level statics. For multi-scene correctness, internal code should use the instance method _computeLinewidth().
Parameters
this
typeof VMobjectRendering
strokeWidth
number
Returns
number