Skip to main content

Class: Vector3D

Defined in: mobjects/three-d/Arrow3D.ts:353

Vector3D - An Arrow3D starting from the origin by default

Extends​

Constructors​

Constructor​

new Vector3D(options): Vector3D

Defined in: mobjects/three-d/Arrow3D.ts:354

Parameters​

options​

Omit<Arrow3DOptions, "start"> & object

Returns​

Vector3D

Overrides​

Arrow3D.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:95

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

Inherited from​

Arrow3D.__savedMobjectState

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:70

Inherited from​

Arrow3D._color

_dirty​

_dirty: boolean = true

Defined in: core/Mobject.ts:88

Inherited from​

Arrow3D._dirty

_disableChildZLayering​

protected _disableChildZLayering: boolean = false

Defined in: core/Mobject.ts:85

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

Inherited from​

Arrow3D._disableChildZLayering

_opacity​

protected _opacity: number = 1

Defined in: core/Mobject.ts:81

Inherited from​

Arrow3D._opacity

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:86

Inherited from​

Arrow3D._style

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:87

Inherited from​

Arrow3D._threeObject

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:65

Inherited from​

Arrow3D.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:69

Inherited from​

Arrow3D.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:83

Inherited from​

Arrow3D.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:63

Inherited from​

Arrow3D.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:64

Inherited from​

Arrow3D.parent

position​

position: Vector3

Defined in: core/Mobject.ts:66

Inherited from​

Arrow3D.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:67

Inherited from​

Arrow3D.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:91

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

Inherited from​

Arrow3D.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:68

Inherited from​

Arrow3D.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:82

Inherited from​

Arrow3D.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:93

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

Arrow3D.targetCopy

Accessors​

animate​

Get Signature​

get animate(): any

Defined in: core/Mobject.ts:497

Returns an AnimateProxy that records method calls. Pass the proxy to scene.play() to animate from the current state to the state after all recorded calls are applied.

Example​
scene.play(circle.animate.shift([2, 0, 0]));
scene.play(circle.animate.setColor('#ff0000').scale(2));
Returns​

any

Inherited from​

Arrow3D.animate

color​

Get Signature​

get color(): string

Defined in: core/Mobject.ts:71

Returns​

string

Set Signature​

set color(value): void

Defined in: core/Mobject.ts:74

Parameters​
value​

string

Returns​

void

Inherited from​

Arrow3D.color

fillColor​

Get Signature​

get fillColor(): string

Defined in: core/Mobject.ts:184

Returns​

string

Set Signature​

set fillColor(color): void

Defined in: core/Mobject.ts:188

Parameters​
color​

string

Returns​

void

Inherited from​

Arrow3D.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:551

Returns​

boolean

Inherited from​

Arrow3D.isDirty

opacity​

Get Signature​

get opacity(): number

Defined in: core/Mobject.ts:114

Returns​

number

Set Signature​

set opacity(value): void

Defined in: core/Mobject.ts:118

Parameters​
value​

number

Returns​

void

Inherited from​

Arrow3D.opacity

strokeColor​

Get Signature​

get strokeColor(): string

Defined in: core/Mobject.ts:195

Returns​

string

Set Signature​

set strokeColor(color): void

Defined in: core/Mobject.ts:199

Parameters​
color​

string

Returns​

void

Inherited from​

Arrow3D.strokeColor

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:122

Returns​

MobjectStyle

Inherited from​

Arrow3D.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:136

Returns​

Mobject[]

Inherited from​

Arrow3D.submobjects

Methods​

_createCopy()​

protected _createCopy(): Arrow3D

Defined in: mobjects/three-d/Arrow3D.ts:336

Create a copy of this Arrow3D

Returns​

Arrow3D

Inherited from​

Arrow3D._createCopy

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: mobjects/three-d/Arrow3D.ts:84

Create the Three.js arrow object (shaft + tip)

Returns​

Object3D

Inherited from​

Arrow3D._createThreeObject

_getBoundingBox()​

_getBoundingBox(): object

Defined in: core/Mobject.ts:449

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Deprecated​

Use getBoundingBox() instead.

Inherited from​

Arrow3D._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:442

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Arrow3D._getEdgeInDirection

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:541

Returns​

void

Inherited from​

Arrow3D._markDirty

_markDirtyUpward()​

_markDirtyUpward(): void

Defined in: core/Mobject.ts:545

Returns​

void

Inherited from​

Arrow3D._markDirtyUpward

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: mobjects/three-d/Arrow3D.ts:180

Sync material properties to Three.js object

Returns​

void

Inherited from​

Arrow3D._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:519

Returns​

void

Inherited from​

Arrow3D._syncToThree

add()​

add(...mobjects): this

Defined in: core/Mobject.ts:329

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Arrow3D.add

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:589

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

Arrow3D.addUpdater

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:427

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.alignTo

applyFunction()​

applyFunction(fn, options?): this

Defined in: core/Mobject.ts:619

Parameters​

fn​

(point) => number[]

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.applyFunction

applyMatrix()​

applyMatrix(matrix, options?): this

Defined in: core/Mobject.ts:627

Parameters​

matrix​

number[][]

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.applyMatrix

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:577

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

Arrow3D.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:376

Parameters​

other​

Mobject

Returns​

this

Inherited from​

Arrow3D.become

center()​

center(): this

Defined in: core/Mobject.ts:479

Returns​

this

Inherited from​

Arrow3D.center

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:601

Returns​

this

Inherited from​

Arrow3D.clearUpdaters

copy()​

copy(): Mobject

Defined in: core/Mobject.ts:358

Returns​

Mobject

Inherited from​

Arrow3D.copy

dispose()​

dispose(): void

Defined in: core/Mobject.ts:658

Returns​

void

Inherited from​

Arrow3D.dispose

flip()​

flip(axis, options?): this

Defined in: core/Mobject.ts:257

Parameters​

axis​

Vector3Tuple = ...

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.flip

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:642

Returns​

Mobject

Inherited from​

Arrow3D.generateTarget

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:458

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:445

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

Arrow3D.getBoundingBox

getBounds()​

getBounds(): object

Defined in: core/Mobject.ts:392

Returns​

object

max​

max: object

max.x​

x: number

max.y​

y: number

max.z​

z: number

min​

min: object

min.x​

x: number

min.y​

y: number

min.z​

z: number

Inherited from​

Arrow3D.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/Mobject.ts:388

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getCenter

getDirection()​

getDirection(): Vector3Tuple

Defined in: mobjects/three-d/Arrow3D.ts:310

Get the direction vector (normalized)

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getDirection

getDisplayMeshes()​

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

Defined in: core/Mobject.ts:569

Returns​

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

Inherited from​

Arrow3D.getDisplayMeshes

getDisplayMeshLength()​

getDisplayMeshLength(): number

Defined in: core/Mobject.ts:565

Number of visible display meshes this mobject contributes when rendered. Used for Transform eligibility checks without forcing Three.js object creation.

Returns​

number

Inherited from​

Arrow3D.getDisplayMeshLength

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:452

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getEdge

getEnd()​

getEnd(): Vector3Tuple

Defined in: mobjects/three-d/Arrow3D.ts:236

Get the end point (tip of the arrow)

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getEnd

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:583

Returns​

Mobject[]

Inherited from​

Arrow3D.getFamily

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:461

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getLeft

getLength()​

getLength(): number

Defined in: mobjects/three-d/Arrow3D.ts:300

Get the length of the arrow

Returns​

number

Inherited from​

Arrow3D.getLength

getMidpoint()​

getMidpoint(): Vector3Tuple

Defined in: mobjects/three-d/Arrow3D.ts:325

Get the midpoint of the arrow

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getMidpoint

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:464

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getRight

getShaftRadius()​

getShaftRadius(): number

Defined in: mobjects/three-d/Arrow3D.ts:284

Get the shaft radius

Returns​

number

Inherited from​

Arrow3D.getShaftRadius

getStart()​

getStart(): Vector3Tuple

Defined in: mobjects/three-d/Arrow3D.ts:220

Get the start point

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getStart

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:555

Returns​

Object3D

Inherited from​

Arrow3D.getThreeObject

getTipLength()​

getTipLength(): number

Defined in: mobjects/three-d/Arrow3D.ts:252

Get the tip length

Returns​

number

Inherited from​

Arrow3D.getTipLength

getTipRadius()​

getTipRadius(): number

Defined in: mobjects/three-d/Arrow3D.ts:268

Get the tip radius

Returns​

number

Inherited from​

Arrow3D.getTipRadius

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:455

Returns​

Vector3Tuple

Inherited from​

Arrow3D.getTop

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:608

Returns​

UpdaterFunction[]

Inherited from​

Arrow3D.getUpdaters

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:605

Returns​

boolean

Inherited from​

Arrow3D.hasUpdaters

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/Mobject.ts:216

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:437

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.moveToAligned

nextTo()​

nextTo(target, direction, buff): this

Defined in: core/Mobject.ts:410

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple = RIGHT

buff​

number = 0.25

Returns​

this

Inherited from​

Arrow3D.nextTo

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:635

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

Arrow3D.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/Mobject.ts:342

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Arrow3D.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:595

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

Arrow3D.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:381

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

Arrow3D.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:652

Returns​

boolean

Inherited from​

Arrow3D.restoreState

rotate()​

rotate(angle, axisOrOptions?): this

Defined in: core/Mobject.ts:237

Rotate the mobject by angle around an axis. Accepts aboutPoint or aboutEdge to specify the rotation center.

Parameters​

angle​

number

axisOrOptions?​

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

Returns​

this

Inherited from​

Arrow3D.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:253

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Arrow3D.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:647

Returns​

this

Inherited from​

Arrow3D.saveState

scale()​

scale(factor, options?): this

Defined in: core/Mobject.ts:283

Parameters​

factor​

number | Vector3Tuple

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.scale

setColor()​

setColor(color): this

Defined in: core/Mobject.ts:140

Parameters​

color​

string

Returns​

this

Inherited from​

Arrow3D.setColor

setEnd()​

setEnd(point): this

Defined in: mobjects/three-d/Arrow3D.ts:243

Set the end point (tip of the arrow)

Parameters​

point​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.setEnd

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:178

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

Arrow3D.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:168

Parameters​

opacity​

number

Returns​

this

Inherited from​

Arrow3D.setFillOpacity

setShaftRadius()​

setShaftRadius(value): this

Defined in: mobjects/three-d/Arrow3D.ts:291

Set the shaft radius

Parameters​

value​

number

Returns​

this

Inherited from​

Arrow3D.setShaftRadius

setStart()​

setStart(point): this

Defined in: mobjects/three-d/Arrow3D.ts:227

Set the start point

Parameters​

point​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.setStart

setStrokeOpacity()​

setStrokeOpacity(opacity): this

Defined in: core/Mobject.ts:148

Parameters​

opacity​

number

Returns​

this

Inherited from​

Arrow3D.setStrokeOpacity

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Mobject.ts:158

Parameters​

width​

number

Returns​

this

Inherited from​

Arrow3D.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:126

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

Arrow3D.setStyle

setTipLength()​

setTipLength(value): this

Defined in: mobjects/three-d/Arrow3D.ts:259

Set the tip length

Parameters​

value​

number

Returns​

this

Inherited from​

Arrow3D.setTipLength

setTipRadius()​

setTipRadius(value): this

Defined in: mobjects/three-d/Arrow3D.ts:275

Set the tip radius

Parameters​

value​

number

Returns​

this

Inherited from​

Arrow3D.setTipRadius

setX()​

setX(x): this

Defined in: core/Mobject.ts:467

Parameters​

x​

number

Returns​

this

Inherited from​

Arrow3D.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:471

Parameters​

y​

number

Returns​

this

Inherited from​

Arrow3D.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:475

Parameters​

z​

number

Returns​

this

Inherited from​

Arrow3D.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:208

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.shift

stretch()​

stretch(factor, dim, options?): this

Defined in: core/Mobject.ts:310

Parameters​

factor​

number

dim​

number

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Arrow3D.stretch

toCorner()​

toCorner(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:509

Parameters​

direction​

Vector3Tuple = ...

buff​

number = 0.5

frameDimensions?​

[number, number]

Returns​

this

Inherited from​

Arrow3D.toCorner

toEdge()​

toEdge(direction, buff, frameDimensions?): this

Defined in: core/Mobject.ts:504

Parameters​

direction​

Vector3Tuple

buff​

number = 0.5

frameDimensions?​

[number, number]

Returns​

this

Inherited from​

Arrow3D.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:612

Parameters​

dt​

number

Returns​

void

Inherited from​

Arrow3D.update