Skip to main content

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​

CodeOptions

Returns​

Code

Overrides​

VMobject.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

JSON-serializable saved state (used by restoreState()).

Inherited from​

VMobject.__savedMobjectState

_backgroundMesh​

protected _backgroundMesh: Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], 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

_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:57

Inherited from​

VMobject._color

_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:75

Inherited from​

VMobject._dirty

_disableChildZLayering​

protected _disableChildZLayering: boolean = false

Defined in: core/Mobject.ts:72

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​

VMobject._fillMaterial

_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​

VMobject._geometryDirty

_highlightMeshes​

protected _highlightMeshes: Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], 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 | Material[], 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:68

Inherited from​

VMobject._opacity

_points3D​

protected _points3D: number[][] = []

Defined in: core/VMobject.ts:38

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​

VMobject._points3D

_sceneFrameWidth​

_sceneFrameWidth: number = null

Defined in: core/VMobjectRendering.ts:78

Inherited from​

VMobject._sceneFrameWidth

_sceneRendererHeight​

_sceneRendererHeight: number = null

Defined in: core/VMobjectRendering.ts:77

Inherited from​

VMobject._sceneRendererHeight

_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​

VMobject._sceneRendererWidth

_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​

VMobject._strokeMaterial

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from​

VMobject._style

_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:74

Inherited from​

VMobject._threeObject

_tokenizedLines​

protected _tokenizedLines: Token[][] = []

Defined in: mobjects/text/Code.ts:118

Tokenized lines for highlighting specific parts

_visiblePointCount​

protected _visiblePointCount: number = null

Defined in: core/VMobject.ts:41

Number of points visible (for Create animation)

Inherited from​

VMobject._visiblePointCount

_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:52

Inherited from​

VMobject.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from​

VMobject.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from​

VMobject.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from​

VMobject.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from​

VMobject.parent

position​

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from​

VMobject.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from​

VMobject.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:78

Saved mobject copy (used by Restore animation). Set by saveState().

Inherited from​

VMobject.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from​

VMobject.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from​

VMobject.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

VMobject.targetCopy

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​

VMobject.useStrokeMesh

_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​

VMobject._frameWidth

_rendererHeight​

static _rendererHeight: number = 450

Defined in: core/VMobjectRendering.ts:66

Inherited from​

VMobject._rendererHeight

_rendererWidth​

static _rendererWidth: number = 800

Defined in: core/VMobjectRendering.ts:65

Renderer resolution for LineMaterial (set by Scene)

Inherited from​

VMobject._rendererWidth

useShaderCurves​

static useShaderCurves: 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​

VMobject.useShaderCurves

Accessors​

color​

Get Signature​

get color(): string

Defined in: core/Mobject.ts:58

Returns​

string

Set Signature​

set color(value): void

Defined in: core/Mobject.ts:61

Parameters​
value​

string

Returns​

void

Inherited from​

VMobject.color

fillColor​

Get Signature​

get fillColor(): string

Defined in: core/Mobject.ts:171

Returns​

string

Set Signature​

set fillColor(color): void

Defined in: core/Mobject.ts:175

Parameters​
color​

string

Returns​

void

Inherited from​

VMobject.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns​

boolean

Inherited from​

VMobject.isDirty

numPoints​

Get Signature​

get numPoints(): number

Defined in: core/VMobject.ts:108

Get the number of points

Returns​

number

Inherited from​

VMobject.numPoints

opacity​

Get Signature​

get opacity(): number

Defined in: core/Mobject.ts:101

Returns​

number

Set Signature​

set opacity(value): void

Defined in: core/Mobject.ts:105

Parameters​
value​

number

Returns​

void

Inherited from​

VMobject.opacity

points​

Get Signature​

get points(): Point[]

Defined in: core/VMobject.ts:58

Get all points as 2D Point objects (derived from _points3D)

Returns​

Point[]

Inherited from​

VMobject.points

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​

VMobject.shaderCurves

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns​

MobjectStyle

Inherited from​

VMobject.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns​

Mobject[]

Inherited from​

VMobject.submobjects

visiblePointCount​

Get Signature​

get visiblePointCount(): number

Defined in: core/VMobject.ts:115

Get the number of visible points (for Create animation)

Returns​

number

Set Signature​

set visiblePointCount(count): void

Defined in: core/VMobject.ts:122

Set the number of visible points (for Create animation)

Parameters​
count​

number

Returns​

void

Inherited from​

VMobject.visiblePointCount

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:361

Build the CSS font string

Returns​

string

_createCopy()​

protected _createCopy(): Code

Defined in: mobjects/text/Code.ts:574

Create a copy of this Code mobject

Returns​

Code

Overrides​

VMobject._createCopy

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: mobjects/text/Code.ts:510

Create the Three.js backing object

Returns​

Object3D

Overrides​

VMobject._createThreeObject

_disposeRenderingResources()​

protected _disposeRenderingResources(): void

Defined in: core/VMobjectRendering.ts:613

Returns​

void

Inherited from​

VMobject._disposeRenderingResources

_getBoundingBox()​

_getBoundingBox(): object

Defined in: core/Mobject.ts:367

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Deprecated​

Use getBoundingBox() instead.

Inherited from​

VMobject._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

VMobject._getEdgeInDirection

_getLineNumberWidth()​

protected _getLineNumberWidth(): number

Defined in: mobjects/text/Code.ts:369

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:448

Interpolate a 3D point list to have a specific number of points.

Parameters​

points​

number[][]

targetCount​

number

Returns​

number[][]

Inherited from​

VMobject._interpolatePointList3D

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns​

void

Inherited from​

VMobject._markDirty

_markDirtyUpward()​

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns​

void

Inherited from​

VMobject._markDirtyUpward

_measureCode()​

protected _measureCode(): object

Defined in: mobjects/text/Code.ts:381

Measure canvas dimensions needed

Returns​

object

height​

height: number

width​

width: number

_parseCode()​

protected _parseCode(): void

Defined in: mobjects/text/Code.ts:178

Parse code into lines and tokenize

Returns​

void

_pointsToCurvePath()​

protected _pointsToCurvePath(): CurvePath<Vector3>

Defined in: core/VMobjectRendering.ts:200

Returns​

CurvePath<Vector3>

Inherited from​

VMobject._pointsToCurvePath

_pointsToShape()​

protected _pointsToShape(): Shape

Defined in: core/VMobjectRendering.ts:196

Returns​

Shape

Inherited from​

VMobject._pointsToShape

_renderToCanvas()​

protected _renderToCanvas(): void

Defined in: mobjects/text/Code.ts:410

Render code to the off-screen canvas

Returns​

void

_roundRect()​

protected _roundRect(x, y, width, height, radius): void

Defined in: mobjects/text/Code.ts:476

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​

VMobject._setSceneContext

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: mobjects/text/Code.ts:552

Sync material properties to Three.js

Returns​

void

Overrides​

VMobject._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns​

void

Inherited from​

VMobject._syncToThree

_updateGeometry()​

protected _updateGeometry(group): void

Defined in: core/VMobjectRendering.ts:245

Update the geometry within the Three.js group.

Parameters​

group​

Group

Returns​

void

Inherited from​

VMobject._updateGeometry

_updateMesh()​

protected _updateMesh(): void

Defined in: mobjects/text/Code.ts:496

Update the mesh geometry to match new dimensions

Returns​

void

add()​

add(...mobjects): this

Defined in: core/Mobject.ts:247

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

VMobject.add

addPoints()​

addPoints(...points): this

Defined in: core/VMobject.ts:168

Add points to this VMobject using 2D Point objects

Parameters​

points​

...Point[]

Returns​

this

Inherited from​

VMobject.addPoints

addPointsAsCorners()​

addPointsAsCorners(corners): this

Defined in: core/VMobject.ts:223

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​

VMobject.addPointsAsCorners

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

VMobject.addUpdater

alignPoints()​

alignPoints(target): void

Defined in: core/VMobject.ts:322

Align points between this VMobject and a target so they have the same count, consistent winding, and optimal rotation for smooth morphing.

Parameters​

target​

VMobject

The target VMobject to align with

Returns​

void

Inherited from​

VMobject.alignPoints

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

VMobject.alignTo

applyFunction()​

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters​

fn​

(point) => number[]

Returns​

this

Inherited from​

VMobject.applyFunction

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

VMobject.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:294

Parameters​

other​

Mobject

Returns​

this

Inherited from​

VMobject.become

center()​

center(): this

Defined in: core/Mobject.ts:397

Returns​

this

Inherited from​

VMobject.center

clearHighlights()​

clearHighlights(): this

Defined in: mobjects/text/Code.ts:346

Clear all line highlights

Returns​

this

this for chaining

clearPoints()​

clearPoints(): this

Defined in: core/VMobject.ts:257

Clear all points

Returns​

this

Inherited from​

VMobject.clearPoints

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns​

this

Inherited from​

VMobject.clearUpdaters

copy()​

copy(): VMobject

Defined in: core/VMobject.ts:496

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​

VMobject

Inherited from​

VMobject.copy

dispose()​

dispose(): void

Defined in: mobjects/text/Code.ts:593

Clean up Three.js and canvas resources

Returns​

void

Overrides​

VMobject.dispose

flip()​

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters​

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

VMobject.flip

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns​

Mobject

Inherited from​

VMobject.generateTarget

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns​

Vector3Tuple

Inherited from​

VMobject.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

VMobject.getBoundingBox

getBounds()​

getBounds(): object

Defined in: core/Mobject.ts:310

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​

VMobject.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: mobjects/text/Code.ts:567

Get the center of this code mobject

Returns​

Vector3Tuple

Overrides​

VMobject.getCenter

getCode()​

getCode(): string

Defined in: mobjects/text/Code.ts:190

Get the code content

Returns​

string

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

VMobject.getEdge

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns​

Mobject[]

Inherited from​

VMobject.getFamily

getHeight()​

getHeight(): number

Defined in: mobjects/text/Code.ts:246

Get code height in world units

Returns​

number

getLanguage()​

getLanguage(): string

Defined in: mobjects/text/Code.ts:211

Get the language

Returns​

string

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns​

Vector3Tuple

Inherited from​

VMobject.getLeft

getLineCount()​

getLineCount(): number

Defined in: mobjects/text/Code.ts:232

Get the number of lines

Returns​

number

getLineOfCode()​

getLineOfCode(lineNumber): object

Defined in: mobjects/text/Code.ts:256

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:101

Get all points defining this VMobject as 3D arrays

Returns​

number[][]

Copy of the points array

Inherited from​

VMobject.getPoints

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns​

Vector3Tuple

Inherited from​

VMobject.getRight

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns​

Object3D

Inherited from​

VMobject.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns​

Vector3Tuple

Inherited from​

VMobject.getTop

getUnitVector()​

getUnitVector(): Vector3Tuple

Defined in: core/VMobject.ts:524

Get the unit vector from the first to the last point of this VMobject, accounting for the object's current rotation transform.

Returns​

Vector3Tuple

Inherited from​

VMobject.getUnitVector

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns​

UpdaterFunction[]

Inherited from​

VMobject.getUpdaters

getVisiblePointCount()​

getVisiblePointCount(): number

Defined in: core/VMobject.ts:157

Get the visible point count (null means all points visible).

Returns​

number

Inherited from​

VMobject.getVisiblePointCount

getVisiblePoints()​

getVisiblePoints(): Point[]

Defined in: core/VMobject.ts:131

Get points that should be visible (for rendering) as 2D Points

Returns​

Point[]

Inherited from​

VMobject.getVisiblePoints

getVisiblePoints3D()​

getVisiblePoints3D(): number[][]

Defined in: core/VMobject.ts:139

Get points that should be visible (for rendering) as 3D arrays

Returns​

number[][]

Inherited from​

VMobject.getVisiblePoints3D

getWidth()​

getWidth(): number

Defined in: mobjects/text/Code.ts:239

Get code width in world units

Returns​

number

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns​

boolean

Inherited from​

VMobject.hasUpdaters

highlightLines()​

highlightLines(startLine, endLine, color): this

Defined in: mobjects/text/Code.ts:286

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:275

Interpolate this VMobject towards a target VMobject

Parameters​

target​

VMobject

The target VMobject to interpolate towards

alpha​

number

Progress from 0 (this) to 1 (target)

Returns​

this

this for chaining

Inherited from​

VMobject.interpolate

markGeometryDirty()​

markGeometryDirty(): void

Defined in: core/VMobjectRendering.ts:180

Mark geometry as needing rebuild on next render.

Returns​

void

Inherited from​

VMobject.markGeometryDirty

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/Mobject.ts:192

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

VMobject.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

VMobject.moveToAligned

nextTo()​

nextTo(target, direction, buff): this

Defined in: core/Mobject.ts:328

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple = RIGHT

buff​

number = 0.25

Returns​

this

Inherited from​

VMobject.nextTo

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

VMobject.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/Mobject.ts:260

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

VMobject.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

VMobject.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

VMobject.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns​

boolean

Inherited from​

VMobject.restoreState

rotate()​

rotate(angle, axisOrOptions?): this

Defined in: core/Mobject.ts:213

Rotate the mobject around an axis. Delegates to rotateMobject for the heavy lifting.

Parameters​

angle​

number

axisOrOptions?​

Vector3Tuple | { aboutPoint?: Vector3Tuple; axis?: Vector3Tuple; }

Returns​

this

Inherited from​

VMobject.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

VMobject.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:521

Returns​

this

Inherited from​

VMobject.saveState

scale()​

scale(factor): this

Defined in: core/Mobject.ts:233

Parameters​

factor​

number | Vector3Tuple

Returns​

this

Inherited from​

VMobject.scale

setCode()​

setCode(code): this

Defined in: mobjects/text/Code.ts:199

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:127

Parameters​

color​

string

Returns​

this

Inherited from​

VMobject.setColor

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

VMobject.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:155

Parameters​

opacity​

number

Returns​

this

Inherited from​

VMobject.setFillOpacity

setLanguage()​

setLanguage(language): this

Defined in: mobjects/text/Code.ts:220

Set language and re-render

Parameters​

language​

string

Programming language

Returns​

this

this for chaining

setOpacity()​

setOpacity(opacity): this

Defined in: core/Mobject.ts:135

Parameters​

opacity​

number

Returns​

this

Inherited from​

VMobject.setOpacity

setPoints()​

setPoints(points): this

Defined in: core/VMobject.ts:68

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​

VMobject.setPoints

setPoints3D()​

setPoints3D(points): this

Defined in: core/VMobject.ts:93

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​

VMobject.setPoints3D

setPointsAsCorners()​

setPointsAsCorners(corners): this

Defined in: core/VMobject.ts:182

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​

VMobject.setPointsAsCorners

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Mobject.ts:145

Parameters​

width​

number

Returns​

this

Inherited from​

VMobject.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

VMobject.setStyle

setVisiblePointCount()​

setVisiblePointCount(count): void

Defined in: core/VMobject.ts:148

Set visible point count for progressive creation animations. Use null to show all points.

Parameters​

count​

number

Returns​

void

Inherited from​

VMobject.setVisiblePointCount

setX()​

setX(x): this

Defined in: core/Mobject.ts:385

Parameters​

x​

number

Returns​

this

Inherited from​

VMobject.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:389

Parameters​

y​

number

Returns​

this

Inherited from​

VMobject.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters​

z​

number

Returns​

this

Inherited from​

VMobject.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:184

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

VMobject.shift

toCorner()​

toCorner(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:406

Parameters​

direction​

Vector3Tuple = ...

buff​

number = 0.5

frameDimensions?​

[number, number]

Returns​

this

Inherited from​

VMobject.toCorner

toEdge()​

toEdge(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:401

Parameters​

direction​

Vector3Tuple

buff​

number = 0.5

frameDimensions?​

[number, number]

Returns​

this

Inherited from​

VMobject.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:497

Parameters​

dt​

number

Returns​

void

Inherited from​

VMobject.update

_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

Inherited from​

VMobject._toLinewidth