Class: ArrowVectorField

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

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

• VectorField

Constructors

Constructor

new ArrowVectorField(options): ArrowVectorField

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

Parameters

options

ArrowVectorFieldOptions

Returns

ArrowVectorField

Overrides

VectorField.constructor

Properties

__savedMobjectState

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from

VectorField.__savedMobjectState

---

_color

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from

VectorField._color

---

_colorFunc

protected _colorFunc: ColorFunction

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

Inherited from

VectorField._colorFunc

---

_dirty

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from

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

VectorField._disableChildZLayering

---

_func

protected _func: VectorFunction

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

Inherited from

VectorField._func

---

_lengthScale

protected _lengthScale: number

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

Inherited from

VectorField._lengthScale

---

_maxArrowLength

protected _maxArrowLength: number

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

---

_maxMagnitude

protected _maxMagnitude: number

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

Inherited from

VectorField._maxMagnitude

---

_minMagnitude

protected _minMagnitude: number

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

Inherited from

VectorField._minMagnitude

---

_normalizeArrows

protected _normalizeArrows: boolean

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

---

_opacity

protected _opacity: number

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

Inherited from

VectorField._opacity

---

_strokeWidth

protected _strokeWidth: number

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

Inherited from

VectorField._strokeWidth

---

_style

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from

VectorField._style

---

_threeObject

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from

VectorField._threeObject

---

_tipLength

protected _tipLength: number

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

---

_xRange

protected _xRange: [number, number, number]

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

Inherited from

VectorField._xRange

---

_yRange

protected _yRange: [number, number, number]

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

Inherited from

VectorField._yRange

---

children

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from

VectorField.children

---

createdAtBeginning

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from

VectorField.createdAtBeginning

---

fillOpacity

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from

VectorField.fillOpacity

---

id

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from

VectorField.id

---

parent

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from

VectorField.parent

---

position

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from

VectorField.position

---

rotation

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from

VectorField.rotation

---

savedState

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from

VectorField.savedState

---

scaleVector

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from

VectorField.scaleVector

---

strokeWidth

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from

VectorField.strokeWidth

---

targetCopy

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from

VectorField.targetCopy

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

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

VectorField.fillColor

---

isDirty

Get Signature

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns

boolean

Inherited from

VectorField.isDirty

---

length

Get Signature

get length(): number

Defined in: core/Group.ts:260

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

Returns

number

Set Signature

set opacity(value): void

Defined in: core/Mobject.ts:105

Parameters

value

number

Returns

void

Inherited from

VectorField.opacity

---

style

Get Signature

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns

MobjectStyle

Inherited from

VectorField.style

---

submobjects

Get Signature

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns

Mobject[]

Inherited from

VectorField.submobjects

Methods

_createCopy()

protected _createCopy(): ArrowVectorField

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

Create a copy of this ArrowVectorField

Returns

ArrowVectorField

Overrides

VectorField._createCopy

---

_createThreeObject()

protected _createThreeObject(): Object3D

Defined in: core/Group.ts:238

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

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

---

_generateGridPoints()

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

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

Generate grid sample points

Returns

[number, number][]

Array of [x, y] coordinates

Inherited from

VectorField._generateGridPoints

---

_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

VectorField._getBoundingBox

---

_getColor()

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

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

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

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

VectorField._getEdgeInDirection

---

_magnitude()

protected _magnitude(vx, vy): number

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

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

Returns

void

Inherited from

VectorField._markDirty

---

_markDirtyUpward()

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns

void

Inherited from

VectorField._markDirtyUpward

---

_regenerate()

protected _regenerate(): void

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

Regenerate the vector field

Returns

void

Overrides

VectorField._regenerate

---

_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: core/Mobject.ts:436

Returns

void

Inherited from

VectorField._syncMaterialToThree

---

_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns

void

Inherited from

VectorField._syncToThree

---

[iterator]()

[iterator](): Iterator<Mobject>

Defined in: core/Group.ts:276

Iterate over all mobjects in the group.

Returns

Iterator<Mobject>

Inherited from

VectorField.[iterator]

---

add()

add(mobject): this

Defined in: core/Group.ts:31

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

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

VectorField.addUpdater

---

alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple

Returns

this

Inherited from

VectorField.alignTo

---

applyFunction()

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters

fn

(point) => number[]

Returns

this

Inherited from

VectorField.applyFunction

---

applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters

func

(mobject) => void

Returns

this

Inherited from

VectorField.applyToFamily

---

become()

become(other): this

Defined in: core/Mobject.ts:294

Parameters

other

Mobject

Returns

this

Inherited from

VectorField.become

---

center()

center(): this

Defined in: core/Mobject.ts:397

Returns

this

Inherited from

VectorField.center

---

clear()

clear(): this

Defined in: core/Group.ts:73

Remove all children from this group.

Returns

this

this for chaining

Inherited from

VectorField.clear

---

clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns

this

Inherited from

VectorField.clearUpdaters

---

copy()

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns

Mobject

Inherited from

VectorField.copy

---

dispose()

dispose(): void

Defined in: core/Mobject.ts:532

Returns

void

Inherited from

VectorField.dispose

---

filter()

filter(fn): Group

Defined in: core/Group.ts:304

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): this

Defined in: core/Mobject.ts:225

Parameters

axis

Vector3Tuple = ...

Returns

this

Inherited from

VectorField.flip

---

forEach()

forEach(fn): this

Defined in: core/Group.ts:285

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

Returns

Mobject

Inherited from

VectorField.generateTarget

---

get()

get(index): Mobject

Defined in: core/Group.ts:269

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

Returns

Vector3Tuple

Inherited from

VectorField.getBottom

---

getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

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

VectorField.getBounds

---

getCenter()

getCenter(): Vector3Tuple

Defined in: core/Group.ts:86

Get the center of the group (average of all children centers). Children maintain world-space coordinates, so no group position offset is added (shift/moveTo only update children, not group position).

Returns

Vector3Tuple

Center position as [x, y, z]

Inherited from

VectorField.getCenter

---

getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

VectorField.getEdge

---

getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns

Mobject[]

Inherited from

VectorField.getFamily

---

getFunction()

getFunction(): VectorFunction

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

Get the vector function

Returns

VectorFunction

Inherited from

VectorField.getFunction

---

getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns

Vector3Tuple

Inherited from

VectorField.getLeft

---

getLengthScale()

getLengthScale(): number

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

Get the length scale factor

Returns

number

Inherited from

VectorField.getLengthScale

---

getMaxArrowLength()

getMaxArrowLength(): number

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

Get the maximum arrow length

Returns

number

---

getNormalizeArrows()

getNormalizeArrows(): boolean

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

Get whether arrows are normalized

Returns

boolean

---

getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns

Vector3Tuple

Inherited from

VectorField.getRight

---

getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns

Object3D

Inherited from

VectorField.getThreeObject

---

getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns

Vector3Tuple

Inherited from

VectorField.getTop

---

getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns

UpdaterFunction[]

Inherited from

VectorField.getUpdaters

---

getXRange()

getXRange(): [number, number, number]

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

Get the X range

Returns

[number, number, number]

Inherited from

VectorField.getXRange

---

getYRange()

getYRange(): [number, number, number]

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

Get the Y range

Returns

[number, number, number]

Inherited from

VectorField.getYRange

---

hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns

boolean

Inherited from

VectorField.hasUpdaters

---

interpolateFunction()

interpolateFunction(func, alpha): this

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

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

---

map()

map<T>(fn): T[]

Defined in: core/Group.ts:295

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/Group.ts:127

Move the group center to the given point, or align with another Mobject.

Parameters

target

Target position [x, y, z] or Mobject to align with

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Optional edge direction to align (e.g., UL aligns upper-left edges)

Returns

this

this for chaining

Inherited from

VectorField.moveTo

---

moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters

target

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Inherited from

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

VectorField.nextTo

---

prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters

numPieces

number = 50

Returns

this

Inherited from

VectorField.prepareForNonlinearTransform

---

remove()

remove(mobject): this

Defined in: core/Group.ts:56

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

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

VectorField.removeUpdater

---

replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters

target

Mobject

stretch

boolean = false

Returns

this

Inherited from

VectorField.replace

---

restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns

boolean

Inherited from

VectorField.restoreState

---

rotate()

rotate(angle, axisOrOptions?): this

Defined in: core/Group.ts:157

Rotate all children around an axis. Only children are rotated to avoid double-counting with Three.js hierarchy.

Parameters

angle

number

Rotation angle in radians

axisOrOptions?

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

Returns

this

this for chaining

Inherited from

VectorField.rotate

---

rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

VectorField.rotateAboutOrigin

---

saveState()

saveState(): this

Defined in: core/Mobject.ts:521

Returns

this

Inherited from

VectorField.saveState

---

scale()

scale(factor): this

Defined in: core/Group.ts:174

Scale all children. Only children are scaled to avoid double-counting with Three.js hierarchy.

Parameters

factor

Scale factor (number for uniform, tuple for non-uniform)

number | Vector3Tuple

Returns

this

this for chaining

Inherited from

VectorField.scale

---

setColor()

setColor(color): this

Defined in: core/Group.ts:187

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

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

VectorField.setFill

---

setFillOpacity()

setFillOpacity(opacity): this

Defined in: core/Group.ts:226

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

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

Set the length scale factor

Parameters

scale

number

Returns

this

Inherited from

VectorField.setLengthScale

---

setMaxArrowLength()

setMaxArrowLength(length): this

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

Set the maximum arrow length

Parameters

length

number

Returns

this

---

setNormalizeArrows()

setNormalizeArrows(normalize): this

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

Set whether arrows should be normalized

Parameters

normalize

boolean

Returns

this

---

setOpacity()

setOpacity(opacity): this

Defined in: core/Group.ts:200

Set the opacity of all children.

Parameters

opacity

number

Opacity value (0-1)

Returns

this

this for chaining

Inherited from

VectorField.setOpacity

---

setStrokeWidth()

setStrokeWidth(width): this

Defined in: core/Group.ts:213

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

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

VectorField.setStyle

---

setX()

setX(x): this

Defined in: core/Mobject.ts:385

Parameters

x

number

Returns

this

Inherited from

VectorField.setX

---

setY()

setY(y): this

Defined in: core/Mobject.ts:389

Parameters

y

number

Returns

this

Inherited from

VectorField.setY

---

setZ()

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters

z

number

Returns

this

Inherited from

VectorField.setZ

---

shift()

shift(delta): this

Defined in: core/Group.ts:113

Shift all children by the given delta. Only children are shifted (they maintain world-space coordinates). The group's own position is NOT updated to avoid double-counting when getCenter() computes the average of children centers.

Parameters

delta

Vector3Tuple

Translation vector [x, y, z]

Returns

this

this for chaining

Inherited from

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

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

VectorField.toEdge

---

update()

update(dt): void

Defined in: core/Mobject.ts:497

Parameters

dt

number

Returns

void

Inherited from

VectorField.update