Skip to main content

Class: ArrowVectorField

Defined in: mobjects/graphing/VectorField.ts:360

ArrowVectorField - Vector field visualization using arrows

Displays a grid of arrows representing the vector field, where:

  • Arrow position indicates the sample point
  • Arrow direction indicates the vector direction
  • Arrow length indicates the vector magnitude (unless normalized)
  • Arrow color can indicate magnitude or use a custom function

Example​

// Create a rotation field
const rotationField = new ArrowVectorField({
  func: (x, y) => [-y, x],
  xRange: [-3, 3, 0.5],
  yRange: [-3, 3, 0.5],
  color: '#00ff00'
});

// Create a field with magnitude-based coloring
const gradientField = new ArrowVectorField({
  func: (x, y) => [Math.sin(y), Math.cos(x)],
  color: (mag) => mag > 0.5 ? '#ff0000' : '#0000ff'
});

Extends​

Constructors​

Constructor​

new ArrowVectorField(options): ArrowVectorField

Defined in: mobjects/graphing/VectorField.ts:365

Parameters​

options​

ArrowVectorFieldOptions

Returns​

ArrowVectorField

Overrides​

VectorField.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:121

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

Inherited from​

VectorField.__savedMobjectState

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:84

Inherited from​

VectorField._color

_colorFunc​

protected _colorFunc: ColorFunction

Defined in: mobjects/graphing/VectorField.ts:143

Inherited from​

VectorField._colorFunc

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

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

VectorField._disableChildZLayering

_func​

protected _func: VectorFunction

Defined in: mobjects/graphing/VectorField.ts:139

Inherited from​

VectorField._func

_isVMobject​

_isVMobject: boolean = false

Defined in: core/Mobject.ts:114

Inherited from​

VectorField._isVMobject

_lengthScale​

protected _lengthScale: number

Defined in: mobjects/graphing/VectorField.ts:142

Inherited from​

VectorField._lengthScale

_maxArrowLength​

protected _maxArrowLength: number

Defined in: mobjects/graphing/VectorField.ts:362

_maxMagnitude​

protected _maxMagnitude: number

Defined in: mobjects/graphing/VectorField.ts:145

Inherited from​

VectorField._maxMagnitude

_minMagnitude​

protected _minMagnitude: number

Defined in: mobjects/graphing/VectorField.ts:144

Inherited from​

VectorField._minMagnitude

_normalizeArrows​

protected _normalizeArrows: boolean

Defined in: mobjects/graphing/VectorField.ts:363

_opacity​

protected _opacity: number

Defined in: mobjects/graphing/VectorField.ts:147

Inherited from​

VectorField._opacity

_strokeWidth​

protected _strokeWidth: number

Defined in: mobjects/graphing/VectorField.ts:146

Inherited from​

VectorField._strokeWidth

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:100

Inherited from​

VectorField._style

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:101

Inherited from​

VectorField._threeObject

_tipLength​

protected _tipLength: number

Defined in: mobjects/graphing/VectorField.ts:361

_xRange​

protected _xRange: [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:140

Inherited from​

VectorField._xRange

_yRange​

protected _yRange: [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:141

Inherited from​

VectorField._yRange

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:79

Inherited from​

VectorField.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:83

Inherited from​

VectorField.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:97

Inherited from​

VectorField.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:77

Inherited from​

VectorField.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:78

Inherited from​

VectorField.parent

position​

position: Vector3

Defined in: core/Mobject.ts:80

Inherited from​

VectorField.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:81

Inherited from​

VectorField.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:117

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

Inherited from​

VectorField.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:82

Inherited from​

VectorField.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:96

Inherited from​

VectorField.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:119

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

VectorField.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​

VectorField.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​

VectorField.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​

VectorField.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:935

Returns​

boolean

Inherited from​

VectorField.isDirty

length​

Get Signature​

get length(): number

Defined in: core/Group.ts:214

Get the number of mobjects in this group.

Returns​

number

Inherited from​

VectorField.length

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​

VectorField.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​

VectorField.strokeColor

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:148

Returns​

MobjectStyle

Inherited from​

VectorField.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:162

Returns​

Mobject[]

Inherited from​

VectorField.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​

VectorField._applyFunctionAboutPoint

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: core/Group.ts:183

Create the Three.js backing object for this Group. A group is simply a THREE.Group that contains children.

Returns​

Object3D

Inherited from​

VectorField._createThreeObject

_evaluateVector()​

protected _evaluateVector(x, y): [number, number]

Defined in: mobjects/graphing/VectorField.ts:207

Evaluate the vector function at a point

Parameters​

x​

number

X coordinate

y​

number

Y coordinate

Returns​

[number, number]

Vector [vx, vy] with magnitude constraints applied

Inherited from​

VectorField._evaluateVector

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

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

VectorField._flattenAsMesh

_generateGridPoints()​

protected _generateGridPoints(): [number, number][]

Defined in: mobjects/graphing/VectorField.ts:187

Generate grid sample points

Returns​

[number, number][]

Array of [x, y] coordinates

Inherited from​

VectorField._generateGridPoints

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

VectorField._getBoundingBox

_getColor()​

protected _getColor(x, y, vx, vy): string

Defined in: mobjects/graphing/VectorField.ts:233

Get the color for a vector at a point

Parameters​

x​

number

X coordinate

y​

number

Y coordinate

vx​

number

Vector X component

vy​

number

Vector Y component

Returns​

string

CSS color string

Inherited from​

VectorField._getColor

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

VectorField._getEdgeInDirection

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

VectorField._localToWorld

_magnitude()​

protected _magnitude(vx, vy): number

Defined in: mobjects/graphing/VectorField.ts:241

Calculate the magnitude of a vector

Parameters​

vx​

number

vy​

number

Returns​

number

Inherited from​

VectorField._magnitude

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

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

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

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

VectorField._ownMatrix

_regenerate()​

protected _regenerate(): void

Defined in: mobjects/graphing/VectorField.ts:438

Regenerate the vector field

Returns​

void

Overrides​

VectorField._regenerate

_root()​

_root(): Mobject

Defined in: core/Mobject.ts:940

The topmost ancestor (the node with no parent).

Returns​

Mobject

Inherited from​

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

VectorField._rotateAboutParentLocalPoint

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: core/Mobject.ts:892

Returns​

void

Inherited from​

VectorField._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:870

Returns​

void

Inherited from​

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

VectorField._syncWorldMatrices

_worldMatrix()​

_worldMatrix(): Matrix4

Defined in: core/Mobject.ts:974

Returns​

Matrix4

Inherited from​

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

VectorField._worldToLocal

[iterator]()​

[iterator](): Iterator<Mobject>

Defined in: core/Group.ts:230

Iterate over all mobjects in the group.

Returns​

Iterator<Mobject>

Inherited from​

VectorField.[iterator]

add()​

add(mobject): this

Defined in: core/Group.ts:38

Add a mobject to this group.

Parameters​

mobject​

Mobject

Mobject to add

Returns​

this

this for chaining

Inherited from​

VectorField.add

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:1010

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

VectorField.addUpdater

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:713

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

VectorField.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​

VectorField.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​

VectorField.applyFunctionAboutPoint

applyMatrix()​

applyMatrix(matrix, options?): this

Defined in: core/Mobject.ts:1076

Parameters​

matrix​

number[][]

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

VectorField.applyMatrix

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:998

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

VectorField.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:592

Parameters​

other​

Mobject

Returns​

this

Inherited from​

VectorField.become

center()​

center(): this

Defined in: core/Mobject.ts:772

Returns​

this

Inherited from​

VectorField.center

clear()​

clear(): this

Defined in: core/Group.ts:80

Remove all children from this group.

Returns​

this

this for chaining

Inherited from​

VectorField.clear

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:1022

Returns​

this

Inherited from​

VectorField.clearUpdaters

copy()​

copy(): ArrowVectorField

Defined in: mobjects/graphing/VectorField.ts:475

Create a copy of this Group.

Returns​

ArrowVectorField

Overrides​

VectorField.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​

VectorField.disableChildZLayering

dispose()​

dispose(): void

Defined in: core/Mobject.ts:1117

Returns​

void

Inherited from​

VectorField.dispose

filter()​

filter(fn): Group

Defined in: core/Group.ts:258

Filter mobjects in the group.

Parameters​

fn​

(mobject, index) => boolean

Filter predicate

Returns​

Group

New Group with filtered mobjects

Inherited from​

VectorField.filter

flip()​

flip(axis, options?): this

Defined in: core/Mobject.ts:403

Parameters​

axis​

Vector3Tuple = ...

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

VectorField.flip

forEach()​

forEach(fn): this

Defined in: core/Group.ts:239

Apply a function to each mobject in the group.

Parameters​

fn​

(mobject, index) => void

Function to apply

Returns​

this

this for chaining

Inherited from​

VectorField.forEach

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:1091

Returns​

Mobject

Inherited from​

VectorField.generateTarget

get()​

get(index): Mobject

Defined in: core/Group.ts:223

Get a mobject by index.

Parameters​

index​

number

Index of the mobject

Returns​

Mobject

The mobject at the given index, or undefined

Inherited from​

VectorField.get

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:751

Returns​

Vector3Tuple

Inherited from​

VectorField.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:732

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

VectorField.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​

VectorField.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/Group.ts:101

World-space center as the midpoint of the union of all children's bounding boxes.

Each child computes its own bounding box via getBounds(), which routes to the correct strategy automatically: VMobjects use point math, all other types use Box3.setFromObject(). See PointBounds.ts for the full explanation.

Returns​

Vector3Tuple

Throws​

this.isEmpty() — an empty group has no geometry, so no center.

Post​

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

Inherited from​

VectorField.getCenter

getDisplayMeshes()​

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

Defined in: core/Group.ts:198

Returns​

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

Inherited from​

VectorField.getDisplayMeshes

getDisplayMeshLength()​

getDisplayMeshLength(): number

Defined in: core/Group.ts:194

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​

VectorField.getDisplayMeshLength

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:745

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

VectorField.getEdge

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:1004

Returns​

Mobject[]

Inherited from​

VectorField.getFamily

getFunction()​

getFunction(): VectorFunction

Defined in: mobjects/graphing/VectorField.ts:248

Get the vector function

Returns​

VectorFunction

Inherited from​

VectorField.getFunction

getHeight()​

getHeight(): number

Defined in: core/Mobject.ts:738

Returns​

number

Inherited from​

VectorField.getHeight

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:754

Returns​

Vector3Tuple

Inherited from​

VectorField.getLeft

getLengthScale()​

getLengthScale(): number

Defined in: mobjects/graphing/VectorField.ts:288

Get the length scale factor

Returns​

number

Inherited from​

VectorField.getLengthScale

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​

VectorField.getLocalCenter

getMaxArrowLength()​

getMaxArrowLength(): number

Defined in: mobjects/graphing/VectorField.ts:471

Get the maximum arrow length

Returns​

number

getNormalizeArrows()​

getNormalizeArrows(): boolean

Defined in: mobjects/graphing/VectorField.ts:455

Get whether arrows are normalized

Returns​

boolean

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:757

Returns​

Vector3Tuple

Inherited from​

VectorField.getRight

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:944

Returns​

Object3D

Inherited from​

VectorField.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:748

Returns​

Vector3Tuple

Inherited from​

VectorField.getTop

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:1029

Returns​

UpdaterFunction[]

Inherited from​

VectorField.getUpdaters

getWidth()​

getWidth(): number

Defined in: core/Mobject.ts:735

Returns​

number

Inherited from​

VectorField.getWidth

getXRange()​

getXRange(): [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:265

Get the X range

Returns​

[number, number, number]

Inherited from​

VectorField.getXRange

getYRange()​

getYRange(): [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:272

Get the Y range

Returns​

[number, number, number]

Inherited from​

VectorField.getYRange

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:1026

Returns​

boolean

Inherited from​

VectorField.hasUpdaters

interpolateFunction()​

interpolateFunction(func, alpha): this

Defined in: mobjects/graphing/VectorField.ts:306

Update the vector field for animation purposes Allows smooth updates to the vector function

Parameters​

func​

VectorFunction

New vector function

alpha​

number

Interpolation factor (0-1)

Returns​

this

Inherited from​

VectorField.interpolateFunction

isEmpty()​

isEmpty(): boolean

Defined in: core/Group.ts:87

Whether this mobject has no renderable geometry. Base default is conservative: non-empty unless specialized subclasses decide otherwise.

Returns​

boolean

Inherited from​

VectorField.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​

VectorField.isTransformNormalized

map()​

map<T>(fn): T[]

Defined in: core/Group.ts:249

Map over all mobjects in the group.

Type Parameters​

T​

T

Parameters​

fn​

(mobject, index) => T

Mapping function

Returns​

T[]

Array of mapped values

Inherited from​

VectorField.map

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​

VectorField.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:723

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

VectorField.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​

VectorField.nextTo

normalizeTransform()​

normalizeTransform(worldMatrix): this

Defined in: core/Group.ts:14

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​

VectorField.normalizeTransform

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:1084

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

VectorField.prepareForNonlinearTransform

remove()​

remove(mobject): this

Defined in: core/Group.ts:63

Remove a mobject from this group.

Parameters​

mobject​

Mobject

Mobject to remove

Returns​

this

this for chaining

Inherited from​

VectorField.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:1016

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

VectorField.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:597

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

VectorField.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:1101

Returns​

boolean

Inherited from​

VectorField.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​

VectorField.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:344

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

VectorField.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:1096

Returns​

this

Inherited from​

VectorField.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​

VectorField.scale

setColor()​

setColor(color): this

Defined in: core/Group.ts:132

Set the color of all children.

Parameters​

color​

string

CSS color string

Returns​

this

this for chaining

Inherited from​

VectorField.setColor

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:204

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

VectorField.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Group.ts:171

Set the fill opacity of all children.

Parameters​

opacity​

number

Fill opacity (0-1)

Returns​

this

this for chaining

Inherited from​

VectorField.setFillOpacity

setFunction()​

setFunction(func): this

Defined in: mobjects/graphing/VectorField.ts:256

Set a new vector function and regenerate the field

Parameters​

func​

VectorFunction

New vector function

Returns​

this

Inherited from​

VectorField.setFunction

setLengthScale()​

setLengthScale(scale): this

Defined in: mobjects/graphing/VectorField.ts:279

Set the length scale factor

Parameters​

scale​

number

Returns​

this

Inherited from​

VectorField.setLengthScale

setMaxArrowLength()​

setMaxArrowLength(length): this

Defined in: mobjects/graphing/VectorField.ts:462

Set the maximum arrow length

Parameters​

length​

number

Returns​

this

setNormalizeArrows()​

setNormalizeArrows(normalize): this

Defined in: mobjects/graphing/VectorField.ts:446

Set whether arrows should be normalized

Parameters​

normalize​

boolean

Returns​

this

setStrokeOpacity()​

setStrokeOpacity(opacity): this

Defined in: core/Group.ts:145

Set the stroke opacity of all children.

Parameters​

opacity​

number

Opacity value (0-1)

Returns​

this

this for chaining

Inherited from​

VectorField.setStrokeOpacity

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Group.ts:158

Set the stroke width of all children.

Parameters​

width​

number

Stroke width in pixels

Returns​

this

this for chaining

Inherited from​

VectorField.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:152

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

VectorField.setStyle

setX()​

setX(x): this

Defined in: core/Mobject.ts:760

Parameters​

x​

number

Returns​

this

Inherited from​

VectorField.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:764

Parameters​

y​

number

Returns​

this

Inherited from​

VectorField.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:768

Parameters​

z​

number

Returns​

this

Inherited from​

VectorField.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:234

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

VectorField.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​

VectorField.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​

VectorField.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​

VectorField.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:1033

Parameters​

dt​

number

Returns​

void

Inherited from​

VectorField.update