Class: Mobject1D

Defined in: mobjects/point/Mobject1D.ts:50

Mobject1D - 1D point distribution along a line

Points are distributed along a line segment between start and end. You can specify either a fixed number of points or a density (points per unit length).

Example

// Create a line of 10 points from origin to (2, 0, 0)
const line = new Mobject1D({
  start: [0, 0, 0],
  end: [2, 0, 0],
  numPoints: 10,
});

// Create a line with density of 5 points per unit
const denseLine = new Mobject1D({
  start: [-1, -1, 0],
  end: [1, 1, 0],
  density: 5,
  color: '#00ff00',
});

Extends

• PMobject

Constructors

Constructor

new Mobject1D(options): Mobject1D

Defined in: mobjects/point/Mobject1D.ts:56

Parameters

options

Mobject1DOptions = {}

Returns

Mobject1D

Overrides

PMobject.constructor

Properties

__savedMobjectState

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from

PMobject.__savedMobjectState

---

_color

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from

PMobject._color

---

_density?

protected optional _density: number

Defined in: mobjects/point/Mobject1D.ts:54

---

_dirty

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from

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

PMobject._disableChildZLayering

---

_end

protected _end: Vector3Tuple

Defined in: mobjects/point/Mobject1D.ts:52

---

_geometry

protected _geometry: BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap> = null

Defined in: mobjects/point/PMobject.ts:65

THREE.js geometry for points

Inherited from

PMobject._geometry

---

_material

protected _material: PointsMaterial = null

Defined in: mobjects/point/PMobject.ts:68

THREE.js material for points

Inherited from

PMobject._material

---

_numPointsConfig

protected _numPointsConfig: number

Defined in: mobjects/point/Mobject1D.ts:53

---

_opacity

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from

PMobject._opacity

---

_points

protected _points: PointData[] = []

Defined in: mobjects/point/PMobject.ts:59

Internal point data storage

Inherited from

PMobject._points

---

_pointSize

protected _pointSize: number = 10

Defined in: mobjects/point/PMobject.ts:62

Point size in pixels

Inherited from

PMobject._pointSize

---

_start

protected _start: Vector3Tuple

Defined in: mobjects/point/Mobject1D.ts:51

---

_style

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from

PMobject._style

---

_threeObject

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from

PMobject._threeObject

---

children

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from

PMobject.children

---

createdAtBeginning

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from

PMobject.createdAtBeginning

---

fillOpacity

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from

PMobject.fillOpacity

---

id

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from

PMobject.id

---

parent

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from

PMobject.parent

---

position

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from

PMobject.position

---

rotation

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from

PMobject.rotation

---

savedState

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from

PMobject.savedState

---

scaleVector

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from

PMobject.scaleVector

---

strokeWidth

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from

PMobject.strokeWidth

---

targetCopy

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from

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

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

PMobject.fillColor

---

isDirty

Get Signature

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns

boolean

Inherited from

PMobject.isDirty

---

numPoints

Get Signature

get numPoints(): number

Defined in: mobjects/point/PMobject.ts:150

Get the number of points

Returns

number

Inherited from

PMobject.numPoints

---

opacity

Get Signature

get opacity(): number

Defined in: core/Mobject.ts:101

Returns

number

Set Signature

set opacity(value): void

Defined in: core/Mobject.ts:105

Parameters

value

number

Returns

void

Inherited from

PMobject.opacity

---

style

Get Signature

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns

MobjectStyle

Inherited from

PMobject.style

---

submobjects

Get Signature

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns

Mobject[]

Inherited from

PMobject.submobjects

Methods

_createCopy()

protected _createCopy(): Mobject1D

Defined in: mobjects/point/Mobject1D.ts:275

Create a copy of this Mobject1D

Returns

Mobject1D

Overrides

PMobject._createCopy

---

_createThreeObject()

protected _createThreeObject(): Object3D

Defined in: mobjects/point/PMobject.ts:242

Create the Three.js backing object

Returns

Object3D

Inherited from

PMobject._createThreeObject

---

_generatePoints()

protected _generatePoints(): void

Defined in: mobjects/point/Mobject1D.ts:105

Generate points along the line

Returns

void

---

_getActualNumPoints()

protected _getActualNumPoints(): number

Defined in: mobjects/point/Mobject1D.ts:94

Get the actual number of points based on config or density

Returns

number

---

_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

PMobject._getBoundingBox

---

_getEdgeInDirection()

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

PMobject._getEdgeInDirection

---

_markDirty()

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns

void

Inherited from

PMobject._markDirty

---

_markDirtyUpward()

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns

void

Inherited from

PMobject._markDirtyUpward

---

_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: mobjects/point/PMobject.ts:297

Sync material properties to Three.js

Returns

void

Inherited from

PMobject._syncMaterialToThree

---

_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns

void

Inherited from

PMobject._syncToThree

---

_updateGeometry()

protected _updateGeometry(): void

Defined in: mobjects/point/PMobject.ts:253

Update or create the geometry from points

Returns

void

Inherited from

PMobject._updateGeometry

---

_updateMaterial()

protected _updateMaterial(): void

Defined in: mobjects/point/PMobject.ts:278

Update or create the material

Returns

void

Inherited from

PMobject._updateMaterial

---

add()

add(...mobjects): this

Defined in: core/Mobject.ts:247

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

PMobject.add

---

addPoint()

addPoint(point): this

Defined in: mobjects/point/PMobject.ts:90

Add a single point to the mobject

Parameters

point

PointData

Point data with position and optional color/opacity

Returns

this

this for chaining

Inherited from

PMobject.addPoint

---

addPoints()

addPoints(points): this

Defined in: mobjects/point/PMobject.ts:105

Add multiple points to the mobject

Parameters

points

PointData[]

Array of point data

Returns

this

this for chaining

Inherited from

PMobject.addPoints

---

addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

PMobject.addUpdater

---

alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple

Returns

this

Inherited from

PMobject.alignTo

---

applyFunction()

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters

fn

(point) => number[]

Returns

this

Inherited from

PMobject.applyFunction

---

applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters

func

(mobject) => void

Returns

this

Inherited from

PMobject.applyToFamily

---

become()

become(other): this

Defined in: core/Mobject.ts:294

Parameters

other

Mobject

Returns

this

Inherited from

PMobject.become

---

center()

center(): this

Defined in: core/Mobject.ts:397

Returns

this

Inherited from

PMobject.center

---

clearPoints()

clearPoints(): this

Defined in: mobjects/point/PMobject.ts:129

Clear all points

Returns

this

this for chaining

Inherited from

PMobject.clearPoints

---

clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns

this

Inherited from

PMobject.clearUpdaters

---

copy()

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns

Mobject

Inherited from

PMobject.copy

---

dispose()

dispose(): void

Defined in: mobjects/point/PMobject.ts:322

Clean up Three.js resources

Returns

void

Inherited from

PMobject.dispose

---

flip()

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters

axis

Vector3Tuple = ...

Returns

this

Inherited from

PMobject.flip

---

generateTarget()

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns

Mobject

Inherited from

PMobject.generateTarget

---

getBottom()

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns

Vector3Tuple

Inherited from

PMobject.getBottom

---

getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

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

PMobject.getBounds

---

getCenter()

getCenter(): Vector3Tuple

Defined in: mobjects/point/Mobject1D.ts:203

Get the center of the line segment

Returns

Vector3Tuple

Overrides

PMobject.getCenter

---

getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

PMobject.getEdge

---

getEnd()

getEnd(): Vector3Tuple

Defined in: mobjects/point/Mobject1D.ts:138

Get the end point

Returns

Vector3Tuple

---

getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns

Mobject[]

Inherited from

PMobject.getFamily

---

getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns

Vector3Tuple

Inherited from

PMobject.getLeft

---

getLength()

getLength(): number

Defined in: mobjects/point/Mobject1D.ts:84

Calculate the length of the line segment

Returns

number

---

getPoints()

getPoints(): PointData[]

Defined in: mobjects/point/PMobject.ts:139

Get all points

Returns

PointData[]

Copy of the points array

Inherited from

PMobject.getPoints

---

getPointSize()

getPointSize(): number

Defined in: mobjects/point/PMobject.ts:168

Get the point size

Returns

number

Inherited from

PMobject.getPointSize

---

getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns

Vector3Tuple

Inherited from

PMobject.getRight

---

getStart()

getStart(): Vector3Tuple

Defined in: mobjects/point/Mobject1D.ts:131

Get the start point

Returns

Vector3Tuple

---

getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns

Object3D

Inherited from

PMobject.getThreeObject

---

getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns

Vector3Tuple

Inherited from

PMobject.getTop

---

getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns

UpdaterFunction[]

Inherited from

PMobject.getUpdaters

---

hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns

boolean

Inherited from

PMobject.hasUpdaters

---

moveTo()

moveTo(point): this

Defined in: mobjects/point/Mobject1D.ts:215

Move the line to center at a new position

Parameters

point

Vector3Tuple

Target center position [x, y, z]

Returns

this

Overrides

PMobject.moveTo

---

moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters

target

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Inherited from

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

PMobject.nextTo

---

prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters

numPieces

number = 50

Returns

this

Inherited from

PMobject.prepareForNonlinearTransform

---

regenerate()

regenerate(): this

Defined in: mobjects/point/Mobject1D.ts:267

Regenerate the points

Returns

this

this for chaining

---

remove()

remove(...mobjects): this

Defined in: core/Mobject.ts:260

Parameters

mobjects

...Mobject[]

Returns

this

Inherited from

PMobject.remove

---

removePoint()

removePoint(index): this

Defined in: mobjects/point/PMobject.ts:117

Remove a point by index

Parameters

index

number

Index of point to remove

Returns

this

this for chaining

Inherited from

PMobject.removePoint

---

removeUpdater()

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

PMobject.removeUpdater

---

replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters

target

Mobject

stretch

boolean = false

Returns

this

Inherited from

PMobject.replace

---

restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns

boolean

Inherited from

PMobject.restoreState

---

rotate()

rotate(angle, axisOrOptions?): this

Defined in: core/Mobject.ts:213

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

Parameters

angle

number

axisOrOptions?

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

Returns

this

Inherited from

PMobject.rotate

---

rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

PMobject.rotateAboutOrigin

---

saveState()

saveState(): this

Defined in: core/Mobject.ts:521

Returns

this

Inherited from

PMobject.saveState

---

scale()

scale(factor): this

Defined in: core/Mobject.ts:233

Parameters

factor

number | Vector3Tuple

Returns

this

Inherited from

PMobject.scale

---

setColor()

setColor(color): this

Defined in: mobjects/point/PMobject.ts:177

Set the color of all points

Parameters

color

string

CSS color string

Returns

this

this for chaining

Inherited from

PMobject.setColor

---

setDensity()

setDensity(density): this

Defined in: mobjects/point/Mobject1D.ts:194

Set the density and regenerate (overrides numPoints)

Parameters

density

number

Points per unit length

Returns

this

this for chaining

---

setEnd()

setEnd(end): this

Defined in: mobjects/point/Mobject1D.ts:158

Set the end point and regenerate

Parameters

end

Vector3Tuple

New end point [x, y, z]

Returns

this

this for chaining

---

setEndpoints()

setEndpoints(start, end): this

Defined in: mobjects/point/Mobject1D.ts:170

Set both endpoints and regenerate

Parameters

start

Vector3Tuple

New start point [x, y, z]

end

Vector3Tuple

New end point [x, y, z]

Returns

this

this for chaining

---

setFill()

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

PMobject.setFill

---

setFillOpacity()

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:155

Parameters

opacity

number

Returns

this

Inherited from

PMobject.setFillOpacity

---

setNumPoints()

setNumPoints(count): this

Defined in: mobjects/point/Mobject1D.ts:182

Set the number of points and regenerate (clears density)

Parameters

count

number

Number of points

Returns

this

this for chaining

---

setOpacity()

setOpacity(opacity): this

Defined in: mobjects/point/PMobject.ts:190

Set the opacity of all points

Parameters

opacity

number

Opacity value (0-1)

Returns

this

this for chaining

Inherited from

PMobject.setOpacity

---

setPointSize()

setPointSize(size): this

Defined in: mobjects/point/PMobject.ts:159

Set the point size

Parameters

size

number

Size in pixels

Returns

this

this for chaining

Inherited from

PMobject.setPointSize

---

setStart()

setStart(start): this

Defined in: mobjects/point/Mobject1D.ts:147

Set the start point and regenerate

Parameters

start

Vector3Tuple

New start point [x, y, z]

Returns

this

this for chaining

---

setStrokeWidth()

setStrokeWidth(width): this

Defined in: core/Mobject.ts:145

Parameters

width

number

Returns

this

Inherited from

PMobject.setStrokeWidth

---

setStyle()

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

PMobject.setStyle

---

setX()

setX(x): this

Defined in: core/Mobject.ts:385

Parameters

x

number

Returns

this

Inherited from

PMobject.setX

---

setY()

setY(y): this

Defined in: core/Mobject.ts:389

Parameters

y

number

Returns

this

Inherited from

PMobject.setY

---

setZ()

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters

z

number

Returns

this

Inherited from

PMobject.setZ

---

shift()

shift(delta): this

Defined in: mobjects/point/Mobject1D.ts:238

Shift the line by a delta

Parameters

delta

Vector3Tuple

Translation vector [x, y, z]

Returns

this

this for chaining

Overrides

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

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

PMobject.toEdge

---

update()

update(dt): void

Defined in: core/Mobject.ts:497

Parameters

dt

number

Returns

void

Inherited from

PMobject.update