Skip to main content

Class: ComplexPlane

Defined in: mobjects/graphing/ComplexPlane.ts:53

ComplexPlane - A coordinate system for complex numbers

Displays the complex plane with the real axis (horizontal) and imaginary axis (vertical). Provides methods to convert between complex numbers and visual points.

Example

// Create a simple complex plane
const plane = new ComplexPlane();

// Plot a complex number
const z = { re: 2, im: 3 };
const point = plane.n2p(z);

// Convert a point back to a complex number
const z2 = plane.p2n([1, -1, 0]);

Extends

Constructors

Constructor

new ComplexPlane(options): ComplexPlane

Defined in: mobjects/graphing/ComplexPlane.ts:60

Parameters

options

ComplexPlaneOptions = {}

Returns

ComplexPlane

Overrides

NumberPlane.constructor

Properties

__savedMobjectState

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from

NumberPlane.__savedMobjectState


_color

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from

NumberPlane._color


_dirty

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from

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

NumberPlane._disableChildZLayering


_opacity

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from

NumberPlane._opacity


_style

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from

NumberPlane._style


_threeObject

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from

NumberPlane._threeObject


_tipLength

protected _tipLength: number

Defined in: mobjects/graphing/Axes.ts:74

Inherited from

NumberPlane._tipLength


_tips

protected _tips: boolean

Defined in: mobjects/graphing/Axes.ts:73

Inherited from

NumberPlane._tips


_xLength

protected _xLength: number

Defined in: mobjects/graphing/Axes.ts:71

Inherited from

NumberPlane._xLength


_xRange

protected _xRange: [number, number, number]

Defined in: mobjects/graphing/Axes.ts:69

Inherited from

NumberPlane._xRange


_xTip

protected _xTip: VMobject = null

Defined in: mobjects/graphing/Axes.ts:75

Inherited from

NumberPlane._xTip


_yLength

protected _yLength: number

Defined in: mobjects/graphing/Axes.ts:72

Inherited from

NumberPlane._yLength


_yRange

protected _yRange: [number, number, number]

Defined in: mobjects/graphing/Axes.ts:70

Inherited from

NumberPlane._yRange


_yTip

protected _yTip: VMobject = null

Defined in: mobjects/graphing/Axes.ts:76

Inherited from

NumberPlane._yTip


children

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from

NumberPlane.children


createdAtBeginning

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from

NumberPlane.createdAtBeginning


fillOpacity

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from

NumberPlane.fillOpacity


id

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from

NumberPlane.id


parent

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from

NumberPlane.parent


position

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from

NumberPlane.position


rotation

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from

NumberPlane.rotation


savedState

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from

NumberPlane.savedState


scaleVector

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from

NumberPlane.scaleVector


strokeWidth

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from

NumberPlane.strokeWidth


targetCopy

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from

NumberPlane.targetCopy


xAxis

xAxis: NumberLine

Defined in: mobjects/graphing/Axes.ts:65

The x-axis NumberLine

Inherited from

NumberPlane.xAxis


yAxis

yAxis: NumberLine

Defined in: mobjects/graphing/Axes.ts:67

The y-axis NumberLine

Inherited from

NumberPlane.yAxis

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

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

NumberPlane.fillColor


isDirty

Get Signature

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns

boolean

Inherited from

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

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

NumberPlane.opacity


style

Get Signature

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns

MobjectStyle

Inherited from

NumberPlane.style


submobjects

Get Signature

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns

Mobject[]

Inherited from

NumberPlane.submobjects


xRange

Get Signature

get xRange(): [number, number, number]

Defined in: mobjects/graphing/Axes.ts:312

Public accessor for x range (matches Python Manim's ax.x_range)

Returns

[number, number, number]

Inherited from

NumberPlane.xRange


yRange

Get Signature

get yRange(): [number, number, number]

Defined in: mobjects/graphing/Axes.ts:324

Public accessor for y range (matches Python Manim's ax.y_range)

Returns

[number, number, number]

Inherited from

NumberPlane.yRange

Methods

_createCopy()

protected _createCopy(): ComplexPlane

Defined in: mobjects/graphing/ComplexPlane.ts:451

Create a copy of this ComplexPlane

Returns

ComplexPlane

Overrides

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

NumberPlane._createThreeObject


_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

NumberPlane._getBoundingBox


_getEdgeInDirection()

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

NumberPlane._getEdgeInDirection


_markDirty()

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns

void

Inherited from

NumberPlane._markDirty


_markDirtyUpward()

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns

void

Inherited from

NumberPlane._markDirtyUpward


_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: core/Mobject.ts:436

Returns

void

Inherited from

NumberPlane._syncMaterialToThree


_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns

void

Inherited from

NumberPlane._syncToThree


[iterator]()

[iterator](): Iterator<Mobject>

Defined in: core/Group.ts:276

Iterate over all mobjects in the group.

Returns

Iterator<Mobject>

Inherited from

NumberPlane.[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

NumberPlane.add


addCoordinates()

addCoordinates(xVals?, yVals?): this

Defined in: mobjects/graphing/ComplexPlane.ts:370

Add numeric coordinate labels at the specified values.

  • For real (x) values: creates Text labels below the x-axis.
  • For imaginary (y) values: creates Text labels (e.g. "2i", "-i") to the left of the y-axis.

If no values are supplied the ranges are derived from the axis settings.

Parameters

xVals?

number[]

Real-axis values to label (defaults to integer steps from axis range)

yVals?

number[]

Imaginary-axis values to label (defaults to integer steps from axis range)

Returns

this

this for chaining


addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

NumberPlane.addUpdater


alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple

Returns

this

Inherited from

NumberPlane.alignTo


applyComplexFunction()

applyComplexFunction(func): this

Defined in: mobjects/graphing/ComplexPlane.ts:327

Apply a complex function to all children of this plane, warping any VMobject's control points through the function.

Each point is converted to a complex number via p2n(), passed through func, then mapped back to visual space via n2p().

Parameters

func

(z) => Complex

A function mapping one complex number to another

Returns

this

this for chaining


applyFunction()

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters

fn

(point) => number[]

Returns

this

Inherited from

NumberPlane.applyFunction


applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters

func

(mobject) => void

Returns

this

Inherited from

NumberPlane.applyToFamily


become()

become(other): this

Defined in: core/Mobject.ts:294

Parameters

other

Mobject

Returns

this

Inherited from

NumberPlane.become


c2p()

c2p(x, y): Vector3Tuple

Defined in: mobjects/graphing/Axes.ts:247

Alias for coordsToPoint (matches Python Manim's c2p shorthand)

Parameters

x

number

y

number

Returns

Vector3Tuple

Inherited from

NumberPlane.c2p


c2pX()

c2pX(x): number

Defined in: mobjects/graphing/Axes.ts:352

Convert an x coordinate to visual x position

Parameters

x

number

Returns

number

Inherited from

NumberPlane.c2pX


c2pY()

c2pY(y): number

Defined in: mobjects/graphing/Axes.ts:359

Convert a y coordinate to visual y position

Parameters

y

number

Returns

number

Inherited from

NumberPlane.c2pY


center()

center(): this

Defined in: core/Mobject.ts:397

Returns

this

Inherited from

NumberPlane.center


clear()

clear(): this

Defined in: core/Group.ts:73

Remove all children from this group.

Returns

this

this for chaining

Inherited from

NumberPlane.clear


clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns

this

Inherited from

NumberPlane.clearUpdaters


coordsToPoint()

coordsToPoint(x, y): Vector3Tuple

Defined in: mobjects/graphing/Axes.ts:251

Parameters

x

number

y

number

Returns

Vector3Tuple

Inherited from

NumberPlane.coordsToPoint


copy()

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns

Mobject

Inherited from

NumberPlane.copy


dispose()

dispose(): void

Defined in: core/Mobject.ts:532

Returns

void

Inherited from

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

NumberPlane.filter


flip()

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters

axis

Vector3Tuple = ...

Returns

this

Inherited from

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

NumberPlane.forEach


generateTarget()

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns

Mobject

Inherited from

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

NumberPlane.get


getArea()

getArea(graph, xRange, options): VMobject

Defined in: mobjects/graphing/Axes.ts:605

Create a filled area between a graph and either the x-axis or another graph.

Parameters

graph

FunctionGraph

The primary graph boundary

xRange

[number, number]

The x interval [start, end]

options

Area options

boundedGraph?

FunctionGraph

color?

string

opacity?

number

strokeWidth?

number

Returns

VMobject

A filled VMobject representing the area

Inherited from

NumberPlane.getArea


getAxisLabels()

getAxisLabels(xLabelOrOpts?, yLabelArg?): Group

Defined in: mobjects/graphing/Axes.ts:387

Get axis labels ("x" and "y" by default). Labels can be LaTeX strings or pre-built Mobject instances (e.g. Tex, MathTex).

Parameters

xLabelOrOpts?

string | Mobject | { xLabel?: string | Mobject; yLabel?: string | Mobject; }

yLabelArg?

string | Mobject

Returns

Group

A Group containing the two labels

Inherited from

NumberPlane.getAxisLabels


getBackgroundLines()

getBackgroundLines(): Group

Defined in: mobjects/graphing/NumberPlane.ts:263

Get the background lines Group

Returns

Group

Group containing all background grid lines

Inherited from

NumberPlane.getBackgroundLines


getBackgroundLineStyle()

getBackgroundLineStyle(): BackgroundLineStyle

Defined in: mobjects/graphing/NumberPlane.ts:308

Get the background line style

Returns

BackgroundLineStyle

Inherited from

NumberPlane.getBackgroundLineStyle


getBottom()

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns

Vector3Tuple

Inherited from

NumberPlane.getBottom


getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

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

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

NumberPlane.getCenter


getCoordinateLabels()

getCoordinateLabels(): Group

Defined in: mobjects/graphing/ComplexPlane.ts:444

Get the coordinate labels group

Returns

Group


getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

NumberPlane.getEdge


getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns

Mobject[]

Inherited from

NumberPlane.getFamily


getGraphLabel()

getGraphLabel(graph, labelOrOptions?, options?): MathTex

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

Get a label for a graph at a specific x-value. Matches Python Manim's axes.get_graph_label() API.

Parameters

graph

FunctionGraph

The FunctionGraph to label

labelOrOptions?

string | { color?: string; direction?: Vector3Tuple; label?: string; xVal?: number; }

options?

Positioning options

color?

string

direction?

Vector3Tuple

label?

string

xVal?

number

Returns

MathTex

A MathTex label positioned near the graph

Inherited from

NumberPlane.getGraphLabel


getImaginaryLabels()

getImaginaryLabels(): Group

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

Get the imaginary labels group

Returns

Group


getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns

Vector3Tuple

Inherited from

NumberPlane.getLeft


getOrigin()

getOrigin(): Vector3Tuple

Defined in: mobjects/graphing/Axes.ts:345

Get the origin point in visual coordinates

Returns

Vector3Tuple

Inherited from

NumberPlane.getOrigin


getRiemannRectangles()

getRiemannRectangles(graph, options): VGroup

Defined in: mobjects/graphing/Axes.ts:534

Create Riemann sum rectangles under a graph.

Parameters

graph

FunctionGraph

The FunctionGraph to approximate

options

Riemann rectangle options

color?

string

dx?

number

fillOpacity?

number

strokeColor?

string

strokeWidth?

number

xRange?

[number, number]

Returns

VGroup

A VGroup of filled rectangles

Inherited from

NumberPlane.getRiemannRectangles


getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns

Vector3Tuple

Inherited from

NumberPlane.getRight


getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns

Object3D

Inherited from

NumberPlane.getThreeObject


getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns

Vector3Tuple

Inherited from

NumberPlane.getTop


getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns

UpdaterFunction[]

Inherited from

NumberPlane.getUpdaters


getVerticalLine()

getVerticalLine(point, options): VMobject

Defined in: mobjects/graphing/Axes.ts:490

Create a vertical line from the x-axis to a point.

Parameters

point

Vector3Tuple

The target point [x, y, z] in visual coordinates

options

Line options

color?

string

lineFunc?

typeof Line | typeof DashedLine

strokeWidth?

number

Returns

VMobject

A Line from the x-axis to the point

Inherited from

NumberPlane.getVerticalLine


getXAxis()

getXAxis(): NumberLine

Defined in: mobjects/graphing/Axes.ts:293

Get the x-axis NumberLine

Returns

NumberLine

Inherited from

NumberPlane.getXAxis


getXLength()

getXLength(): number

Defined in: mobjects/graphing/Axes.ts:331

Get the visual x length

Returns

number

Inherited from

NumberPlane.getXLength


getXRange()

getXRange(): [number, number, number]

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

Get the x range

Returns

[number, number, number]

Inherited from

NumberPlane.getXRange


getYAxis()

getYAxis(): NumberLine

Defined in: mobjects/graphing/Axes.ts:300

Get the y-axis NumberLine

Returns

NumberLine

Inherited from

NumberPlane.getYAxis


getYLength()

getYLength(): number

Defined in: mobjects/graphing/Axes.ts:338

Get the visual y length

Returns

number

Inherited from

NumberPlane.getYLength


getYRange()

getYRange(): [number, number, number]

Defined in: mobjects/graphing/Axes.ts:319

Get the y range

Returns

[number, number, number]

Inherited from

NumberPlane.getYRange


hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns

boolean

Inherited from

NumberPlane.hasUpdaters


i2gp()

i2gp(x, graph): Vector3Tuple

Defined in: mobjects/graphing/Axes.ts:515

Input to graph point: convert an x value to the visual point on a graph. Shorthand for graph.getPointFromX(x).

Parameters

x

number

The x coordinate in graph space

graph

FunctionGraph

The FunctionGraph

Returns

Vector3Tuple

The visual coordinates on the graph

Inherited from

NumberPlane.i2gp


inputToGraphPoint()

inputToGraphPoint(x, graph): Vector3Tuple

Defined in: mobjects/graphing/Axes.ts:524

Alias for i2gp — convert an x value to the visual point on a graph. Matches Python Manim's axes.input_to_graph_point() API.

Parameters

x

number

graph

FunctionGraph

Returns

Vector3Tuple

Inherited from

NumberPlane.inputToGraphPoint


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

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

NumberPlane.moveTo


moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters

target

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Inherited from

NumberPlane.moveToAligned


n2p()

n2p(z): Vector3Tuple

Defined in: mobjects/graphing/ComplexPlane.ts:138

Convert a complex number to a visual point

Parameters

z

Complex number as {re, im} or a number (treated as real)

number | Complex

Returns

Vector3Tuple

Visual point [x, y, z]


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

NumberPlane.nextTo


p2n()

p2n(point): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:150

Convert a visual point to a complex number

Parameters

point

Vector3Tuple

Visual point [x, y, z]

Returns

Complex

Complex number


plot()

plot(func, options): FunctionGraph

Defined in: mobjects/graphing/Axes.ts:369

Plot a function on these axes, returning a FunctionGraph.

Parameters

func

(x) => number

Function y = f(x)

options

Partial<Omit<FunctionGraphOptions, "func" | "axes">> = {}

Additional FunctionGraph options (color, strokeWidth, etc.)

Returns

FunctionGraph

A FunctionGraph bound to these axes

Inherited from

NumberPlane.plot


plotLineGraph()

plotLineGraph(options): VDict

Defined in: mobjects/graphing/Axes.ts:693

Plot a line graph connecting data points with straight line segments. Returns a VDict with "line_graph" (the connecting line) and "vertex_dots" (dots at each data point).

Matches Python Manim's axes.plot_line_graph() API.

Parameters

options

Line graph options

addVertexDots?

boolean

lineColor?

string

strokeWidth?

number

vertexDotRadius?

number

vertexDotStyle?

{ color?: string; fillOpacity?: number; strokeColor?: string; strokeWidth?: number; }

vertexDotStyle.color?

string

vertexDotStyle.fillOpacity?

number

vertexDotStyle.strokeColor?

string

vertexDotStyle.strokeWidth?

number

xValues

number[]

yValues

number[]

Returns

VDict

A VDict with "line_graph" and "vertex_dots" entries

Inherited from

NumberPlane.plotLineGraph


pointToCoords()

pointToCoords(point): [number, number]

Defined in: mobjects/graphing/Axes.ts:271

Convert visual point coordinates to graph coordinates

Parameters

point

Vector3Tuple

Visual point [x, y, z]

Returns

[number, number]

The graph coordinates [x, y]

Inherited from

NumberPlane.pointToCoords


prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters

numPieces

number = 50

Returns

this

Inherited from

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

NumberPlane.remove


removeUpdater()

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

NumberPlane.removeUpdater


replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters

target

Mobject

stretch

boolean = false

Returns

this

Inherited from

NumberPlane.replace


restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns

boolean

Inherited from

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

NumberPlane.rotate


rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

NumberPlane.rotateAboutOrigin


saveState()

saveState(): this

Defined in: core/Mobject.ts:521

Returns

this

Inherited from

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

NumberPlane.scale


setBackgroundLineStyle()

setBackgroundLineStyle(style): this

Defined in: mobjects/graphing/NumberPlane.ts:296

Set the background line style

Parameters

style

Partial<BackgroundLineStyle>

Returns

this

Inherited from

NumberPlane.setBackgroundLineStyle


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

NumberPlane.setColor


setFill()

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

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

NumberPlane.setFillOpacity


setIncludeBackgroundLines()

setIncludeBackgroundLines(include): this

Defined in: mobjects/graphing/NumberPlane.ts:270

Set whether to show background lines

Parameters

include

boolean

Returns

this

Inherited from

NumberPlane.setIncludeBackgroundLines


setIncludeImaginaryLabels()

setIncludeImaginaryLabels(include): this

Defined in: mobjects/graphing/ComplexPlane.ts:295

Set whether to show imaginary labels

Parameters

include

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

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

NumberPlane.setStrokeWidth


setStyle()

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

NumberPlane.setStyle


setX()

setX(x): this

Defined in: core/Mobject.ts:385

Parameters

x

number

Returns

this

Inherited from

NumberPlane.setX


setY()

setY(y): this

Defined in: core/Mobject.ts:389

Parameters

y

number

Returns

this

Inherited from

NumberPlane.setY


setZ()

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters

z

number

Returns

this

Inherited from

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

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

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

NumberPlane.toEdge


update()

update(dt): void

Defined in: core/Mobject.ts:497

Parameters

dt

number

Returns

void

Inherited from

NumberPlane.update


add()

static add(a, b): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:174

Add two complex numbers

Parameters

a

Complex

b

Complex

Returns

Complex


argument()

static argument(z): number

Defined in: mobjects/graphing/ComplexPlane.ts:167

Get the argument (angle) of a complex number in radians

Parameters

z

Complex

Complex number

Returns

number


conjugate()

static conjugate(z): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:191

Get the conjugate of a complex number

Parameters

z

Complex

Returns

Complex


divide()

static divide(a, b): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:217

Divide two complex numbers: a / b = (a * conj(b)) / |b|^2

Parameters

a

Complex

b

Complex

Returns

Complex


exp()

static exp(z): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:243

Complex exponential: e^z = e^re * (cos(im) + i*sin(im))

Parameters

z

Complex

Returns

Complex


fromPolar()

static fromPolar(r, theta): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:200

Convert polar coordinates to a complex number

Parameters

r

number

Modulus (radius)

theta

number

Argument (angle in radians)

Returns

Complex


log()

static log(z): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:254

Complex logarithm (principal branch): log(z) = ln|z| + i*arg(z)

Parameters

z

Complex

Returns

Complex


modulus()

static modulus(z): number

Defined in: mobjects/graphing/ComplexPlane.ts:159

Get the modulus (absolute value) of a complex number

Parameters

z

Complex

Complex number

Returns

number


multiply()

static multiply(a, b): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:181

Multiply two complex numbers

Parameters

a

Complex

b

Complex

Returns

Complex


pow()

static pow(z, n): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:230

Raise a complex number to a real power: z^n via polar form (r^n * e^(in*theta))

Parameters

z

Complex

Complex number

n

number

Real exponent

Returns

Complex


reciprocal()

static reciprocal(z): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:277

Complex reciprocal: 1/z = conj(z) / |z|^2

Parameters

z

Complex

Returns

Complex


sqrt()

static sqrt(z): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:264

Complex square root (principal root) via polar form

Parameters

z

Complex

Returns

Complex


subtract()

static subtract(a, b): Complex

Defined in: mobjects/graphing/ComplexPlane.ts:210

Subtract two complex numbers: a - b

Parameters

a

Complex

b

Complex

Returns

Complex