Skip to main content

Class: DiGraph

Defined in: mobjects/graph/DiGraph.ts:32

Base mathematical object class. All visible objects in manimweb inherit from this class.

Extends

Constructors

Constructor

new DiGraph(options): DiGraph

Defined in: mobjects/graph/DiGraph.ts:33

Parameters

options

GenericGraphOptions = {}

Returns

DiGraph

Overrides

GenericGraph.constructor

Properties

__savedMobjectState

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:121

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

Inherited from

GenericGraph.__savedMobjectState


_color

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:84

Inherited from

GenericGraph._color


_directed

protected _directed: boolean = false

Defined in: mobjects/graph/GenericGraph.ts:62

Whether this is a directed graph

Inherited from

GenericGraph._directed


_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

GenericGraph._dirty


_disableChildZLayering

protected _disableChildZLayering: boolean = false

Defined in: core/Mobject.ts:99

When true, children skip the 2D z-layering offset in _syncToThree.

Inherited from

GenericGraph._disableChildZLayering


_edgeConfig

protected _edgeConfig: Map<string, EdgeConfig>

Defined in: mobjects/graph/GenericGraph.ts:59

Per-edge configuration

Inherited from

GenericGraph._edgeConfig


_edgeMobjects

protected _edgeMobjects: Map<string, Mobject>

Defined in: mobjects/graph/GenericGraph.ts:44

Map of edge key to Line/Arrow mobject

Inherited from

GenericGraph._edgeMobjects


_edges

protected _edges: EdgeTuple[] = []

Defined in: mobjects/graph/GenericGraph.ts:35

List of edges as [source, target] tuples

Inherited from

GenericGraph._edges


_edgeStyle

protected _edgeStyle: EdgeStyleOptions

Defined in: mobjects/graph/GenericGraph.ts:53

Default edge style

Inherited from

GenericGraph._edgeStyle


_group

protected _group: Group<Object3DEventMap> = null

Defined in: mobjects/graph/GenericGraph.ts:65

Three.js group for this graph

Inherited from

GenericGraph._group


_isVMobject

_isVMobject: boolean = false

Defined in: core/Mobject.ts:114

Inherited from

GenericGraph._isVMobject


_layoutConfig

protected _layoutConfig: LayoutConfig

Defined in: mobjects/graph/GenericGraph.ts:47

Layout configuration

Inherited from

GenericGraph._layoutConfig


_opacity

protected _opacity: number = 1

Defined in: core/Mobject.ts:95

Inherited from

GenericGraph._opacity


_positions

protected _positions: Map<VertexId, Vector3Tuple>

Defined in: mobjects/graph/GenericGraph.ts:38

Map of vertex id to position

Inherited from

GenericGraph._positions


_style

protected _style: MobjectStyle

Defined in: core/Mobject.ts:100

Inherited from

GenericGraph._style


_threeObject

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:101

Inherited from

GenericGraph._threeObject


_vertexConfig

protected _vertexConfig: Map<VertexId, VertexConfig>

Defined in: mobjects/graph/GenericGraph.ts:56

Per-vertex configuration

Inherited from

GenericGraph._vertexConfig


_vertexMobjects

protected _vertexMobjects: Map<VertexId, Dot>

Defined in: mobjects/graph/GenericGraph.ts:41

Map of vertex id to Dot mobject

Inherited from

GenericGraph._vertexMobjects


_vertexStyle

protected _vertexStyle: VertexStyleOptions

Defined in: mobjects/graph/GenericGraph.ts:50

Default vertex style

Inherited from

GenericGraph._vertexStyle


_vertices

protected _vertices: VertexId[] = []

Defined in: mobjects/graph/GenericGraph.ts:32

List of vertex identifiers

Inherited from

GenericGraph._vertices


children

children: Mobject[] = []

Defined in: core/Mobject.ts:79

Inherited from

GenericGraph.children


createdAtBeginning

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:83

Inherited from

GenericGraph.createdAtBeginning


fillOpacity

fillOpacity: number = 0

Defined in: core/Mobject.ts:97

Inherited from

GenericGraph.fillOpacity


id

readonly id: string

Defined in: core/Mobject.ts:77

Inherited from

GenericGraph.id


parent

parent: Mobject = null

Defined in: core/Mobject.ts:78

Inherited from

GenericGraph.parent


position

position: Vector3

Defined in: core/Mobject.ts:80

Inherited from

GenericGraph.position


rotation

rotation: Euler

Defined in: core/Mobject.ts:81

Inherited from

GenericGraph.rotation


savedState

savedState: Mobject = null

Defined in: core/Mobject.ts:117

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

Inherited from

GenericGraph.savedState


scaleVector

scaleVector: Vector3

Defined in: core/Mobject.ts:82

Inherited from

GenericGraph.scaleVector


strokeWidth

strokeWidth: number = 4

Defined in: core/Mobject.ts:96

Inherited from

GenericGraph.strokeWidth


targetCopy

targetCopy: Mobject = null

Defined in: core/Mobject.ts:119

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from

GenericGraph.targetCopy

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

AnimateProxy

Inherited from

GenericGraph.animate


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

GenericGraph.color


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

GenericGraph.fillColor


isDirty

Get Signature

get isDirty(): boolean

Defined in: core/Mobject.ts:935

Returns

boolean

Inherited from

GenericGraph.isDirty


numEdges

Get Signature

get numEdges(): number

Defined in: mobjects/graph/GenericGraph.ts:537

Get the number of edges

Returns

number

Inherited from

GenericGraph.numEdges


numVertices

Get Signature

get numVertices(): number

Defined in: mobjects/graph/GenericGraph.ts:362

Get the number of vertices

Returns

number

Inherited from

GenericGraph.numVertices


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

GenericGraph.opacity


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

GenericGraph.strokeColor


style

Get Signature

get style(): MobjectStyle

Defined in: core/Mobject.ts:148

Returns

MobjectStyle

Inherited from

GenericGraph.style


submobjects

Get Signature

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:162

Returns

Mobject[]

Inherited from

GenericGraph.submobjects

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

GenericGraph._applyFunctionAboutPoint


_computeLayout()

protected _computeLayout(): void

Defined in: mobjects/graph/GenericGraph.ts:155

Compute vertex positions using the layout algorithm

Returns

void

Inherited from

GenericGraph._computeLayout


_createEdgeMobject()

protected _createEdgeMobject(source, target): void

Defined in: mobjects/graph/GenericGraph.ts:218

Create a single edge mobject

Parameters

source

VertexId

target

VertexId

Returns

void

Inherited from

GenericGraph._createEdgeMobject


_createMobjects()

protected _createMobjects(): void

Defined in: mobjects/graph/GenericGraph.ts:167

Create vertex and edge mobjects

Returns

void

Inherited from

GenericGraph._createMobjects


_createThreeObject()

protected _createThreeObject(): Object3D

Defined in: mobjects/graph/GenericGraph.ts:668

Create the Three.js backing object

Returns

Object3D

Inherited from

GenericGraph._createThreeObject


_createVertexMobject()

protected _createVertexMobject(v): void

Defined in: mobjects/graph/GenericGraph.ts:194

Create a single vertex mobject

Parameters

v

VertexId

Returns

void

Inherited from

GenericGraph._createVertexMobject


_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

GenericGraph._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

GenericGraph._flattenAsMesh


_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

GenericGraph._getBoundingBox


_getEdgeInDirection()

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:729

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

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

Inherited from

GenericGraph._getEdgeInDirection


_getEdgeKey()

protected _getEdgeKey(source, target): string

Defined in: mobjects/graph/GenericGraph.ts:142

Get edge key from vertex pair

Parameters

source

VertexId

target

VertexId

Returns

string

Inherited from

GenericGraph._getEdgeKey


_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

Vector3Tuple

Returns

Vector3Tuple

Post

result === this._worldMatrix() * p

Inherited from

GenericGraph._localToWorld


_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

GenericGraph._markDirty


_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

GenericGraph._markDirtyUpward


_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

GenericGraph._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

GenericGraph._ownMatrix


_root()

_root(): Mobject

Defined in: core/Mobject.ts:940

The topmost ancestor (the node with no parent).

Returns

Mobject

Inherited from

GenericGraph._root


_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

Vector3Tuple

pivotLocal

Vector3Tuple

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

GenericGraph._rotateAboutParentLocalPoint


_shortenEdge()

protected _shortenEdge(start, end, radius): [Vector3Tuple, Vector3Tuple]

Defined in: mobjects/graph/GenericGraph.ts:255

Shorten an edge to not overlap with vertex circles

Parameters

start

Vector3Tuple

end

Vector3Tuple

radius

number

Returns

[Vector3Tuple, Vector3Tuple]

Inherited from

GenericGraph._shortenEdge


_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: core/Mobject.ts:892

Returns

void

Inherited from

GenericGraph._syncMaterialToThree


_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:870

Returns

void

Inherited from

GenericGraph._syncToThree


_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

GenericGraph._syncWorldMatrices


_worldMatrix()

_worldMatrix(): Matrix4

Defined in: core/Mobject.ts:974

Returns

Matrix4

Inherited from

GenericGraph._worldMatrix


_worldToLocal()

protected _worldToLocal(p): Vector3Tuple

Defined in: core/Mobject.ts:397

WORLD point -> this node's LOCAL frame. Inverse of _localToWorld.

Parameters

p

Vector3Tuple

Returns

Vector3Tuple

Post

result === this._worldMatrix().invert() * p

Inherited from

GenericGraph._worldToLocal


add()

add(...mobjects): this

Defined in: core/Mobject.ts:481

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

GenericGraph.add


addEdge()

addEdge(source, target, config?): this

Defined in: mobjects/graph/GenericGraph.ts:449

Add an edge to the graph

Parameters

source

VertexId

Source vertex

target

VertexId

Target vertex

config?

EdgeConfig

Optional edge configuration

Returns

this

this for chaining

Inherited from

GenericGraph.addEdge


addEdges()

addEdges(...edges): this

Defined in: mobjects/graph/GenericGraph.ts:480

Add multiple edges to the graph

Parameters

edges

...EdgeTuple[]

Array of [source, target] tuples

Returns

this

this for chaining

Inherited from

GenericGraph.addEdges


addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:1010

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

GenericGraph.addUpdater


addVertex()

addVertex(v, config?): this

Defined in: mobjects/graph/GenericGraph.ts:294

Add a vertex to the graph

Parameters

v

VertexId

Vertex identifier

config?

VertexConfig

Optional vertex configuration

Returns

this

this for chaining

Inherited from

GenericGraph.addVertex


addVertices()

addVertices(...vertices): this

Defined in: mobjects/graph/GenericGraph.ts:316

Add multiple vertices to the graph

Parameters

vertices

...VertexId[]

Array of vertex identifiers

Returns

this

this for chaining

Inherited from

GenericGraph.addVertices


alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:713

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple

Returns

this

Inherited from

GenericGraph.alignTo


applyFunction()

applyFunction(fn, options?): this

Defined in: core/Mobject.ts:1068

Parameters

fn

(point) => number[]

options?
aboutEdge?

Vector3Tuple

aboutPoint?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.applyFunction


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

GenericGraph.applyFunctionAboutPoint


applyMatrix()

applyMatrix(matrix, options?): this

Defined in: core/Mobject.ts:1076

Parameters

matrix

number[][]

options?
aboutEdge?

Vector3Tuple

aboutPoint?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.applyMatrix


applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:998

Parameters

func

(mobject) => void

Returns

this

Inherited from

GenericGraph.applyToFamily


become()

become(other): this

Defined in: core/Mobject.ts:592

Parameters

other

Mobject

Returns

this

Inherited from

GenericGraph.become


center()

center(): this

Defined in: core/Mobject.ts:772

Returns

this

Inherited from

GenericGraph.center


clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:1022

Returns

this

Inherited from

GenericGraph.clearUpdaters


copy()

copy(): DiGraph

Defined in: mobjects/graph/DiGraph.ts:88

Create a copy of this graph

Returns

DiGraph

Overrides

GenericGraph.copy


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

GenericGraph.disableChildZLayering


dispose()

dispose(): void

Defined in: core/Mobject.ts:1117

Returns

void

Inherited from

GenericGraph.dispose


flip()

flip(axis, options?): this

Defined in: core/Mobject.ts:403

Parameters

axis

Vector3Tuple = ...

options?
aboutEdge?

Vector3Tuple

aboutPoint?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.flip


generateTarget()

generateTarget(): Mobject

Defined in: core/Mobject.ts:1091

Returns

Mobject

Inherited from

GenericGraph.generateTarget


getBottom()

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:751

Returns

Vector3Tuple

Inherited from

GenericGraph.getBottom


getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:732

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

GenericGraph.getBoundingBox


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

GenericGraph.getBounds


getCenter()

getCenter(): Vector3Tuple

Defined in: core/Mobject.ts:621

Get center in world coordinates.

Returns

Vector3Tuple

Post

this.isEmpty() => result === this._localToWorld([0,0,0])

Post

!this.isEmpty() => result[i] === (worldBbox.min[i] + worldBbox.max[i]) / 2

Inherited from

GenericGraph.getCenter


getDegree()

getDegree(v): number

Defined in: mobjects/graph/GenericGraph.ts:436

Get the degree of a vertex (number of edges)

Parameters

v

VertexId

Returns

number

Inherited from

GenericGraph.getDegree


getDisplayMeshes()

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

Defined in: core/Mobject.ts:990

Returns

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

Inherited from

GenericGraph.getDisplayMeshes


getDisplayMeshLength()

getDisplayMeshLength(): number

Defined in: core/Mobject.ts:986

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

GenericGraph.getDisplayMeshLength


getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:745

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

GenericGraph.getEdge


getEdgeMobject()

getEdgeMobject(source, target): Mobject

Defined in: mobjects/graph/GenericGraph.ts:552

Get the Line/Arrow mobject for an edge

Parameters

source

VertexId

target

VertexId

Returns

Mobject

Inherited from

GenericGraph.getEdgeMobject


getEdges()

getEdges(): EdgeTuple[]

Defined in: mobjects/graph/GenericGraph.ts:530

Get all edges

Returns

EdgeTuple[]

Inherited from

GenericGraph.getEdges


getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:1004

Returns

Mobject[]

Inherited from

GenericGraph.getFamily


getHeight()

getHeight(): number

Defined in: core/Mobject.ts:738

Returns

number

Inherited from

GenericGraph.getHeight


getInDegree()

getInDegree(v): number

Defined in: mobjects/graph/DiGraph.ts:84

Get in-degree (number of incoming edges)

Parameters

v

VertexId

Returns

number


getInNeighbors()

getInNeighbors(v): VertexId[]

Defined in: mobjects/graph/DiGraph.ts:64

Get in-neighbors (vertices that point to this vertex)

Parameters

v

VertexId

Returns

VertexId[]


getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:754

Returns

Vector3Tuple

Inherited from

GenericGraph.getLeft


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

Vector3Tuple

Post

this.parent === null => result === this.getCenter()

Post

this.parent !== null => result === parent._computeWorldMatrix().invert() * this.getCenter()

Inherited from

GenericGraph.getLocalCenter


getNeighbors()

getNeighbors(v): VertexId[]

Defined in: mobjects/graph/GenericGraph.ts:421

Get neighbors of a vertex (adjacent vertices)

Parameters

v

VertexId

Returns

VertexId[]

Inherited from

GenericGraph.getNeighbors


getOutDegree()

getOutDegree(v): number

Defined in: mobjects/graph/DiGraph.ts:77

Get out-degree (number of outgoing edges)

Parameters

v

VertexId

Returns

number


getOutNeighbors()

getOutNeighbors(v): VertexId[]

Defined in: mobjects/graph/DiGraph.ts:51

Get out-neighbors (vertices this vertex points to)

Parameters

v

VertexId

Returns

VertexId[]


getPositions()

getPositions(): Map<VertexId, Vector3Tuple>

Defined in: mobjects/graph/GenericGraph.ts:600

Get all vertex positions

Returns

Map<VertexId, Vector3Tuple>

Inherited from

GenericGraph.getPositions


getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:757

Returns

Vector3Tuple

Inherited from

GenericGraph.getRight


getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:944

Returns

Object3D

Inherited from

GenericGraph.getThreeObject


getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:748

Returns

Vector3Tuple

Inherited from

GenericGraph.getTop


getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:1029

Returns

UpdaterFunction[]

Inherited from

GenericGraph.getUpdaters


getVertexMobject()

getVertexMobject(v): Dot

Defined in: mobjects/graph/GenericGraph.ts:376

Get the Dot mobject for a vertex

Parameters

v

VertexId

Returns

Dot

Inherited from

GenericGraph.getVertexMobject


getVertexPosition()

getVertexPosition(v): Vector3Tuple

Defined in: mobjects/graph/GenericGraph.ts:383

Get the position of a vertex

Parameters

v

VertexId

Returns

Vector3Tuple

Inherited from

GenericGraph.getVertexPosition


getVertices()

getVertices(): VertexId[]

Defined in: mobjects/graph/GenericGraph.ts:355

Get all vertex identifiers

Returns

VertexId[]

Inherited from

GenericGraph.getVertices


getWidth()

getWidth(): number

Defined in: core/Mobject.ts:735

Returns

number

Inherited from

GenericGraph.getWidth


hasEdge()

hasEdge(source, target): boolean

Defined in: mobjects/graph/GenericGraph.ts:544

Check if the graph contains an edge

Parameters

source

VertexId

target

VertexId

Returns

boolean

Inherited from

GenericGraph.hasEdge


hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:1026

Returns

boolean

Inherited from

GenericGraph.hasUpdaters


hasVertex()

hasVertex(v): boolean

Defined in: mobjects/graph/GenericGraph.ts:369

Check if the graph contains a vertex

Parameters

v

VertexId

Returns

boolean

Inherited from

GenericGraph.hasVertex


highlightPath()

highlightPath(path, vertexColor, edgeColor): this

Defined in: mobjects/graph/GenericGraph.ts:633

Highlight a path (sequence of vertices)

Parameters

path

VertexId[]

vertexColor

string = RED

edgeColor

string = RED

Returns

this

Inherited from

GenericGraph.highlightPath


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

GenericGraph.isEmpty


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

GenericGraph.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

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Post

result world center === target (within the parent's representable frame)

Pre

!this.isEmpty() if needed (e.g., VGroup).

Inherited from

GenericGraph.moveTo


moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:723

Parameters

target

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.moveToAligned


nextTo()

nextTo(target, direction, buff): this

Defined in: core/Mobject.ts:696

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple = RIGHT

buff

number = 0.25

Returns

this

Inherited from

GenericGraph.nextTo


normalizeTransform()

normalizeTransform(worldMatrix): this

Defined in: mobjects/graph/GenericGraph.ts:28

Flatten this mobject's transform into its canonical, absolute representation.

Bakes worldMatrix into the node's own geometry, recurses so every descendant is expressed in the same frame, then resets the local transform to identity. Called with no argument it seeds with this node's OWN matrix, so bake-then-reset preserves world appearance whether or not the node has ancestors — the ancestors keep their transforms and still apply. The recursion (and a detached-clone caller) passes an explicit accumulated matrix.

Implemented per family rather than via a hook so the compiler forces every geometry-owning subclass to declare how it flattens: containers reset to identity (geometry lives in children), point-based mobjects bake worldMatrix into their points, and Three.js meshes — which cannot bake into points — absolutize their local transform instead (see _flattenAsMesh).

Parameters

worldMatrix

Matrix4 = ...

Returns

this

Post

old.getPoints()[i] === this.getPoints()[i] // world geometry preserved, every descendant

Post

this._computeOwnMatrix() === Identity // container/point nodes; meshes: own === worldMatrix

Inherited from

GenericGraph.normalizeTransform


prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:1084

Parameters

numPieces

number = 50

Returns

this

Inherited from

GenericGraph.prepareForNonlinearTransform


remove()

remove(...mobjects): this

Defined in: core/Mobject.ts:496

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

GenericGraph.remove


removeEdge()

removeEdge(source, target): this

Defined in: mobjects/graph/GenericGraph.ts:507

Remove an edge from the graph

Parameters

source

VertexId

Source vertex

target

VertexId

Target vertex

Returns

this

this for chaining

Inherited from

GenericGraph.removeEdge


removeUpdater()

removeUpdater(updater): this

Defined in: core/Mobject.ts:1016

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

GenericGraph.removeUpdater


removeVertex()

removeVertex(v): this

Defined in: mobjects/graph/GenericGraph.ts:334

Remove a vertex from the graph

Parameters

v

VertexId

Vertex identifier

Returns

this

this for chaining

Inherited from

GenericGraph.removeVertex


replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:597

Parameters

target

Mobject

stretch

boolean = false

Returns

this

Inherited from

GenericGraph.replace


resetColors()

resetColors(): this

Defined in: mobjects/graph/GenericGraph.ts:646

Reset all colors to default

Returns

this

Inherited from

GenericGraph.resetColors


restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:1101

Returns

boolean

Inherited from

GenericGraph.restoreState


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

GenericGraph.rotate


rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:344

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

GenericGraph.rotateAboutOrigin


saveState()

saveState(): this

Defined in: core/Mobject.ts:1096

Returns

this

Inherited from

GenericGraph.saveState


scale()

scale(factor, options?): this

Defined in: core/Mobject.ts:429

Parameters

factor

number | Vector3Tuple

options?
aboutEdge?

Vector3Tuple

aboutPoint?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.scale


setColor()

setColor(color): this

Defined in: core/Mobject.ts:166

Parameters

color

string

Returns

this

Inherited from

GenericGraph.setColor


setEdgeColor()

setEdgeColor(source, target, color): this

Defined in: mobjects/graph/GenericGraph.ts:621

Set the color of a specific edge

Parameters

source

VertexId

target

VertexId

color

string

Returns

this

Inherited from

GenericGraph.setEdgeColor


setFill()

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:204

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

GenericGraph.setFill


setFillOpacity()

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:194

Parameters

opacity

number

Returns

this

Inherited from

GenericGraph.setFillOpacity


setLayout()

setLayout(layout): this

Defined in: mobjects/graph/GenericGraph.ts:564

Change the layout algorithm

Parameters

layout

Layout type or configuration

LayoutConfig | LayoutType

Returns

this

this for chaining

Inherited from

GenericGraph.setLayout


setStrokeOpacity()

setStrokeOpacity(opacity): this

Defined in: core/Mobject.ts:174

Parameters

opacity

number

Returns

this

Inherited from

GenericGraph.setStrokeOpacity


setStrokeWidth()

setStrokeWidth(width): this

Defined in: core/Mobject.ts:184

Parameters

width

number

Returns

this

Inherited from

GenericGraph.setStrokeWidth


setStyle()

setStyle(style): this

Defined in: core/Mobject.ts:152

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

GenericGraph.setStyle


setVertexColor()

setVertexColor(v, color): this

Defined in: mobjects/graph/GenericGraph.ts:609

Set the color of a specific vertex

Parameters

v

VertexId

color

string

Returns

this

Inherited from

GenericGraph.setVertexColor


setVertexPosition()

setVertexPosition(v, position): this

Defined in: mobjects/graph/GenericGraph.ts:390

Set the position of a vertex

Parameters

v

VertexId

position

Vector3Tuple

Returns

this

Inherited from

GenericGraph.setVertexPosition


setX()

setX(x): this

Defined in: core/Mobject.ts:760

Parameters

x

number

Returns

this

Inherited from

GenericGraph.setX


setY()

setY(y): this

Defined in: core/Mobject.ts:764

Parameters

y

number

Returns

this

Inherited from

GenericGraph.setY


setZ()

setZ(z): this

Defined in: core/Mobject.ts:768

Parameters

z

number

Returns

this

Inherited from

GenericGraph.setZ


shift()

shift(delta): this

Defined in: core/Mobject.ts:234

Parameters

delta

Vector3Tuple

Returns

this

Inherited from

GenericGraph.shift


stretch()

stretch(factor, dim, options?): this

Defined in: core/Mobject.ts:461

Parameters

factor

number

dim

number

options?
aboutEdge?

Vector3Tuple

aboutPoint?

Vector3Tuple

Returns

this

Inherited from

GenericGraph.stretch


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

GenericGraph.toCorner


toEdge()

toEdge(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:796

Parameters

direction

Vector3Tuple

buff

number = 0.5

frameDimensions?

[number, number]

Returns

this

Inherited from

GenericGraph.toEdge


update()

update(dt): void

Defined in: core/Mobject.ts:1033

Parameters

dt

number

Returns

void

Inherited from

GenericGraph.update