Skip to main content

Class: Surface3D

Defined in: mobjects/three-d/Surface3D.ts:69

Surface3D - A parametric 3D surface

Creates a parametric surface using Three.js ParametricGeometry. The surface is defined by a function that maps (u, v) parameters to 3D points.

Example​

// Create a paraboloid
const paraboloid = new Surface3D({
  func: (u, v) => {
    const x = u * 2 - 1;
    const y = v * 2 - 1;
    const z = x * x + y * y;
    return [x, y, z];
  },
  uRange: [0, 1],
  vRange: [0, 1]
});

// Create a sphere using parametric equations
const sphere = new Surface3D({
  func: (u, v) => {
    const theta = u * Math.PI * 2;
    const phi = v * Math.PI;
    return [
      Math.sin(phi) * Math.cos(theta),
      Math.sin(phi) * Math.sin(theta),
      Math.cos(phi)
    ];
  }
});

Extends​

Extended by​

Constructors​

Constructor​

new Surface3D(options): Surface3D

Defined in: mobjects/three-d/Surface3D.ts:80

Parameters​

options​

Surface3DOptions

Returns​

Surface3D

Overrides​

Mobject3D.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:121

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

Inherited from​

Mobject3D.__savedMobjectState

_centerPoint​

protected _centerPoint: Vector3Tuple

Defined in: mobjects/three-d/Surface3D.ts:77

_checkerboardColors?​

protected optional _checkerboardColors: [string, string]

Defined in: mobjects/three-d/Surface3D.ts:78

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:84

Inherited from​

Mobject3D._color

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

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

Mobject3D._disableChildZLayering

_doubleSided​

protected _doubleSided: boolean

Defined in: mobjects/three-d/Surface3D.ts:76

_func()​

protected _func: (u, v) => Vector3Tuple

Defined in: mobjects/three-d/Surface3D.ts:70

Parameters​

u​

number

v​

number

Returns​

Vector3Tuple

_isVMobject​

_isVMobject: boolean = false

Defined in: core/Mobject.ts:114

Inherited from​

Mobject3D._isVMobject

_opacity​

protected _opacity: number = 1

Defined in: core/Mobject.ts:95

Inherited from​

Mobject3D._opacity

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:100

Inherited from​

Mobject3D._style

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:101

Inherited from​

Mobject3D._threeObject

_uRange​

protected _uRange: [number, number]

Defined in: mobjects/three-d/Surface3D.ts:71

_uResolution​

protected _uResolution: number

Defined in: mobjects/three-d/Surface3D.ts:73

_vRange​

protected _vRange: [number, number]

Defined in: mobjects/three-d/Surface3D.ts:72

_vResolution​

protected _vResolution: number

Defined in: mobjects/three-d/Surface3D.ts:74

_wireframe​

protected _wireframe: boolean

Defined in: mobjects/three-d/Surface3D.ts:75

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:79

Inherited from​

Mobject3D.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:83

Inherited from​

Mobject3D.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:97

Inherited from​

Mobject3D.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:77

Inherited from​

Mobject3D.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:78

Inherited from​

Mobject3D.parent

position​

position: Vector3

Defined in: core/Mobject.ts:80

Inherited from​

Mobject3D.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:81

Inherited from​

Mobject3D.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:117

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

Inherited from​

Mobject3D.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:82

Inherited from​

Mobject3D.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:96

Inherited from​

Mobject3D.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:119

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

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

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

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

Mobject3D.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:935

Returns​

boolean

Inherited from​

Mobject3D.isDirty

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​

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

Mobject3D.strokeColor

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:148

Returns​

MobjectStyle

Inherited from​

Mobject3D.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:162

Returns​

Mobject[]

Inherited from​

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

Mobject3D._applyFunctionAboutPoint

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: mobjects/three-d/Surface3D.ts:223

Create the Three.js parametric surface mesh.

A transparent surface is rendered in two passes to fix self-occlusion (issue #416): a depth-only prepass writes the front-most layer into the depth buffer, then the color pass (depthWrite=false per issue #255) depth-tests against it, so e.g. a bell curve always occludes the flat region behind it. The prepass mesh is created BEFORE the color mesh: with equal renderOrder and projected z, three.js' transparent sort tiebreaks on object.id (reversePainterSortStable — an internal invariant, verified at three r0.184 and pinned by tests), so the lower id is guaranteed to draw first. It stays transparent so it renders after all opaque objects, which therefore remain visible through the translucent surface.

Trade-off: while the prepass is active, another transparent mobject that three.js sorts after this surface gets its fragments behind the surface depth-rejected rather than blended — the surface behaves as a solid translucent layer, not a stack of blendable sheets.

Returns​

Object3D

Overrides​

Mobject3D._createThreeObject

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

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

Mobject3D._flattenAsMesh

_getBoundingBox()​

_getBoundingBox(): object

Defined in: core/Mobject.ts:742

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Deprecated​

Use getBoundingBox() instead.

Inherited from​

Mobject3D._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:729

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

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

Inherited from​

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

Mobject3D._localToWorld

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:920

Mark this node's render/transform state stale and propagate the flag to the root. World-space geometry of any node depends on its ancestors' transforms, so a change anywhere must invalidate the whole ancestor chain; the invariant "a clean node has a clean subtree" then lets _syncToThree()/root-sync skip untouched branches safely.

Returns​

void

Post​

this._dirty && (this.parent => this.parent._dirty)

Inherited from​

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

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

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

Mobject3D._ownMatrix

_root()​

_root(): Mobject

Defined in: core/Mobject.ts:940

The topmost ancestor (the node with no parent).

Returns​

Mobject

Inherited from​

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

Mobject3D._rotateAboutParentLocalPoint

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: mobjects/three-d/Surface3D.ts:253

Sync material properties to Three.js object

Returns​

void

Overrides​

Mobject3D._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:870

Returns​

void

Inherited from​

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

Mobject3D._syncWorldMatrices

_updateGeometry()​

protected _updateGeometry(): void

Defined in: mobjects/three-d/Surface3D.ts:283

Update the geometry with current function and parameters

Returns​

void

_worldMatrix()​

_worldMatrix(): Matrix4

Defined in: core/Mobject.ts:974

Returns​

Matrix4

Inherited from​

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

Mobject3D._worldToLocal

add()​

add(...mobjects): this

Defined in: core/Mobject.ts:481

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Mobject3D.add

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:1010

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

Mobject3D.addUpdater

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:713

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

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

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

Mobject3D.applyFunctionAboutPoint

applyMatrix()​

applyMatrix(matrix, options?): this

Defined in: core/Mobject.ts:1076

Parameters​

matrix​

number[][]

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Mobject3D.applyMatrix

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:998

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

Mobject3D.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:592

Parameters​

other​

Mobject

Returns​

this

Inherited from​

Mobject3D.become

center()​

center(): this

Defined in: core/Mobject.ts:772

Returns​

this

Inherited from​

Mobject3D.center

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:1022

Returns​

this

Inherited from​

Mobject3D.clearUpdaters

copy()​

copy(): Surface3D

Defined in: mobjects/three-d/Surface3D.ts:431

Create a copy of this Surface3D

Returns​

Surface3D

Overrides​

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

Mobject3D.disableChildZLayering

dispose()​

dispose(): void

Defined in: core/Mobject.ts:1117

Returns​

void

Inherited from​

Mobject3D.dispose

evaluate()​

evaluate(u, v): Vector3Tuple

Defined in: mobjects/three-d/Surface3D.ts:423

Evaluate the surface at given parameters

Parameters​

u​

number

U parameter

v​

number

V parameter

Returns​

Vector3Tuple

flip()​

flip(axis, options?): this

Defined in: core/Mobject.ts:403

Parameters​

axis​

Vector3Tuple = ...

options?​
aboutEdge?​

Vector3Tuple

aboutPoint?​

Vector3Tuple

Returns​

this

Inherited from​

Mobject3D.flip

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:1091

Returns​

Mobject

Inherited from​

Mobject3D.generateTarget

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:751

Returns​

Vector3Tuple

Inherited from​

Mobject3D.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:732

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

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

Mobject3D.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/Mobject.ts:621

Get center in world coordinates.

Returns​

Vector3Tuple

Post​

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

Post​

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

Inherited from​

Mobject3D.getCenter

getDisplayMeshes()​

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

Defined in: core/Mobject.ts:990

Returns​

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

Inherited from​

Mobject3D.getDisplayMeshes

getDisplayMeshLength()​

getDisplayMeshLength(): number

Defined in: core/Mobject.ts:986

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

Returns​

number

Inherited from​

Mobject3D.getDisplayMeshLength

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:745

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Mobject3D.getEdge

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:1004

Returns​

Mobject[]

Inherited from​

Mobject3D.getFamily

getFunc()​

getFunc(): (u, v) => Vector3Tuple

Defined in: mobjects/three-d/Surface3D.ts:309

Get the parametric function

Returns​

(u, v): Vector3Tuple

Parameters​
u​

number

v​

number

Returns​

Vector3Tuple

getHeight()​

getHeight(): number

Defined in: core/Mobject.ts:738

Returns​

number

Inherited from​

Mobject3D.getHeight

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:754

Returns​

Vector3Tuple

Inherited from​

Mobject3D.getLeft

getLocalCenter()​

getLocalCenter(): Vector3Tuple

Defined in: core/Mobject.ts:643

Get center in this mobject's parent coordinate frame.

Includes this node's own local transform, excludes ancestor transforms.

Returns​

Vector3Tuple

Post​

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

Post​

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

Inherited from​

Mobject3D.getLocalCenter

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:757

Returns​

Vector3Tuple

Inherited from​

Mobject3D.getRight

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:944

Returns​

Object3D

Inherited from​

Mobject3D.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:748

Returns​

Vector3Tuple

Inherited from​

Mobject3D.getTop

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:1029

Returns​

UpdaterFunction[]

Inherited from​

Mobject3D.getUpdaters

getURange()​

getURange(): [number, number]

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

Get the U parameter range

Returns​

[number, number]

getUResolution()​

getUResolution(): number

Defined in: mobjects/three-d/Surface3D.ts:357

Get the U resolution

Returns​

number

getVRange()​

getVRange(): [number, number]

Defined in: mobjects/three-d/Surface3D.ts:341

Get the V parameter range

Returns​

[number, number]

getVResolution()​

getVResolution(): number

Defined in: mobjects/three-d/Surface3D.ts:373

Get the V resolution

Returns​

number

getWidth()​

getWidth(): number

Defined in: core/Mobject.ts:735

Returns​

number

Inherited from​

Mobject3D.getWidth

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:1026

Returns​

boolean

Inherited from​

Mobject3D.hasUpdaters

isDoubleSided()​

isDoubleSided(): boolean

Defined in: mobjects/three-d/Surface3D.ts:405

Get whether double-sided rendering is enabled

Returns​

boolean

isEmpty()​

isEmpty(): boolean

Defined in: core/Mobject.ts:611

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

Returns​

boolean

Inherited from​

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

Mobject3D.isTransformNormalized

isWireframe()​

isWireframe(): boolean

Defined in: mobjects/three-d/Surface3D.ts:389

Get whether wireframe mode is enabled

Returns​

boolean

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​

Mobject3D.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:723

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

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

Mobject3D.nextTo

normalizeTransform()​

normalizeTransform(worldMatrix): this

Defined in: mobjects/three-d/Mobject3D.ts:18

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​

Mobject3D.normalizeTransform

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:1084

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

Mobject3D.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/Mobject.ts:496

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Mobject3D.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:1016

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

Mobject3D.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:597

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

Mobject3D.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:1101

Returns​

boolean

Inherited from​

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

Mobject3D.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:344

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Mobject3D.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:1096

Returns​

this

Inherited from​

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

Mobject3D.scale

setColor()​

setColor(color): this

Defined in: core/Mobject.ts:166

Parameters​

color​

string

Returns​

this

Inherited from​

Mobject3D.setColor

setDoubleSided()​

setDoubleSided(value): this

Defined in: mobjects/three-d/Surface3D.ts:412

Set double-sided rendering

Parameters​

value​

boolean

Returns​

this

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:204

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

Mobject3D.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:194

Parameters​

opacity​

number

Returns​

this

Inherited from​

Mobject3D.setFillOpacity

setFunc()​

setFunc(func): this

Defined in: mobjects/three-d/Surface3D.ts:316

Set the parametric function

Parameters​

func​

(u, v) => Vector3Tuple

Returns​

this

setStrokeOpacity()​

setStrokeOpacity(opacity): this

Defined in: core/Mobject.ts:174

Parameters​

opacity​

number

Returns​

this

Inherited from​

Mobject3D.setStrokeOpacity

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Mobject.ts:184

Parameters​

width​

number

Returns​

this

Inherited from​

Mobject3D.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:152

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

Mobject3D.setStyle

setURange()​

setURange(range): this

Defined in: mobjects/three-d/Surface3D.ts:332

Set the U parameter range

Parameters​

range​

[number, number]

Returns​

this

setUResolution()​

setUResolution(value): this

Defined in: mobjects/three-d/Surface3D.ts:364

Set the U resolution

Parameters​

value​

number

Returns​

this

setVRange()​

setVRange(range): this

Defined in: mobjects/three-d/Surface3D.ts:348

Set the V parameter range

Parameters​

range​

[number, number]

Returns​

this

setVResolution()​

setVResolution(value): this

Defined in: mobjects/three-d/Surface3D.ts:380

Set the V resolution

Parameters​

value​

number

Returns​

this

setWireframe()​

setWireframe(value): this

Defined in: mobjects/three-d/Surface3D.ts:396

Set wireframe mode

Parameters​

value​

boolean

Returns​

this

setX()​

setX(x): this

Defined in: core/Mobject.ts:760

Parameters​

x​

number

Returns​

this

Inherited from​

Mobject3D.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:764

Parameters​

y​

number

Returns​

this

Inherited from​

Mobject3D.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:768

Parameters​

z​

number

Returns​

this

Inherited from​

Mobject3D.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:234

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

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

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

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

Mobject3D.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:1033

Parameters​

dt​

number

Returns​

void

Inherited from​

Mobject3D.update