Skip to main content

Class: DiceFace

Defined in: mobjects/probability/DiceFace.ts:100

DiceFace - A square with dots arranged like a standard die face (1-6).

Creates a visual representation of a single die face with configurable size, dot color, background color, and corner radius. The dots (pips) follow the standard Western die layout.

Example​

// Create a die face showing 5
const face = new DiceFace({ value: 5 });

// Create a smaller red die face showing 3
const redDie = new DiceFace({
  value: 3,
  size: 1,
  backgroundColor: '#CC0000',
  dotColor: WHITE,
});

// Show all six faces in a row
const dice = new VGroup();
for (let i = 1; i <= 6; i++) {
  dice.add(new DiceFace({ value: i }));
}
dice.arrange(RIGHT, 0.3);

Extends​

Constructors​

Constructor​

new DiceFace(options): DiceFace

Defined in: mobjects/probability/DiceFace.ts:117

Parameters​

options​

DiceFaceOptions = {}

Returns​

DiceFace

Overrides​

VGroup.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from​

VGroup.__savedMobjectState

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from​

VGroup._color

_dirty​

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from​

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

VGroup._disableChildZLayering

_fillMaterial​

protected _fillMaterial: MeshBasicMaterial = null

Defined in: core/VMobjectRendering.ts:39

Three.js fill material

Inherited from​

VGroup._fillMaterial

_geometryDirty​

protected _geometryDirty: boolean = true

Defined in: core/VMobjectRendering.ts:42

Whether geometry needs rebuild (separate from material dirty)

Inherited from​

VGroup._geometryDirty

_opacity​

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from​

VGroup._opacity

_points3D​

protected _points3D: number[][] = []

Defined in: core/VMobject.ts:38

Array of cubic Bezier control points in 3D. Each point is [x, y, z]. Stored as: [anchor1, handle1, handle2, anchor2, handle3, handle4, anchor3, ...]

Inherited from​

VGroup._points3D

_sceneFrameWidth​

_sceneFrameWidth: number = null

Defined in: core/VMobjectRendering.ts:78

Inherited from​

VGroup._sceneFrameWidth

_sceneRendererHeight​

_sceneRendererHeight: number = null

Defined in: core/VMobjectRendering.ts:77

Inherited from​

VGroup._sceneRendererHeight

_sceneRendererWidth​

_sceneRendererWidth: number = null

Defined in: core/VMobjectRendering.ts:76

Per-instance renderer context (set by Scene when VMobject is added). When non-null these override the class-level statics so that multiple Scene instances do not corrupt each other's stroke-width calculations.

Inherited from​

VGroup._sceneRendererWidth

_strokeMaterial​

protected _strokeMaterial: LineMaterial = null

Defined in: core/VMobjectRendering.ts:36

Three.js stroke material (Line2 LineMaterial for thick strokes)

Inherited from​

VGroup._strokeMaterial

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from​

VGroup._style

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from​

VGroup._threeObject

_visiblePointCount​

protected _visiblePointCount: number = null

Defined in: core/VMobject.ts:41

Number of points visible (for Create animation)

Inherited from​

VGroup._visiblePointCount

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from​

VGroup.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from​

VGroup.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from​

VGroup.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from​

VGroup.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from​

VGroup.parent

position​

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from​

VGroup.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from​

VGroup.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from​

VGroup.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from​

VGroup.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from​

VGroup.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

VGroup.targetCopy

useStrokeMesh​

useStrokeMesh: boolean = false

Defined in: core/VMobjectRendering.ts:146

When true, render stroke as a mesh ring with miter-joined corners instead of Line2 for closed paths.

Inherited from​

VGroup.useStrokeMesh

_frameWidth​

static _frameWidth: number = 14

Defined in: core/VMobjectRendering.ts:69

Camera frame width in world units (set by Scene, for stroke width conversion)

Inherited from​

VGroup._frameWidth

_rendererHeight​

static _rendererHeight: number = 450

Defined in: core/VMobjectRendering.ts:66

Inherited from​

VGroup._rendererHeight

_rendererWidth​

static _rendererWidth: number = 800

Defined in: core/VMobjectRendering.ts:65

Renderer resolution for LineMaterial (set by Scene)

Inherited from​

VGroup._rendererWidth

useShaderCurves​

static useShaderCurves: boolean = false

Defined in: core/VMobjectRendering.ts:131

When true, VMobjects use GPU Bezier SDF shaders for stroke rendering instead of the default Line2/LineMaterial approach.

Inherited from​

VGroup.useShaderCurves

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​

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

VGroup.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns​

boolean

Inherited from​

VGroup.isDirty

length​

Get Signature​

get length(): number

Defined in: core/VGroup.ts:478

Get the number of vmobjects in this group.

Returns​

number

Inherited from​

VGroup.length

numPoints​

Get Signature​

get numPoints(): number

Defined in: core/VMobject.ts:108

Get the number of points

Returns​

number

Inherited from​

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

VGroup.opacity

points​

Get Signature​

get points(): Point[]

Defined in: core/VGroup.ts:531

Get all points from the VGroup as a flat array (override VMobject). Returns combined points from all children.

Returns​

Point[]

Inherited from​

VGroup.points

shaderCurves​

Get Signature​

get shaderCurves(): boolean

Defined in: core/VMobjectRendering.ts:168

Check whether this instance should use shader-based Bezier curve rendering.

Returns​

boolean

Set Signature​

set shaderCurves(value): void

Defined in: core/VMobjectRendering.ts:173

Enable or disable shader-based Bezier rendering for this instance.

Parameters​
value​

boolean

Returns​

void

Inherited from​

VGroup.shaderCurves

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns​

MobjectStyle

Inherited from​

VGroup.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns​

Mobject[]

Inherited from​

VGroup.submobjects

visiblePointCount​

Get Signature​

get visiblePointCount(): number

Defined in: core/VMobject.ts:115

Get the number of visible points (for Create animation)

Returns​

number

Set Signature​

set visiblePointCount(count): void

Defined in: core/VMobject.ts:122

Set the number of visible points (for Create animation)

Parameters​
count​

number

Returns​

void

Inherited from​

VGroup.visiblePointCount

Methods​

_buildEarcutFillGeometry()​

protected _buildEarcutFillGeometry(points3D): BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

Defined in: core/VMobjectRendering.ts:204

Parameters​

points3D​

number[][]

Returns​

BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

Inherited from​

VGroup._buildEarcutFillGeometry

_createCopy()​

protected _createCopy(): VMobject

Defined in: mobjects/probability/DiceFace.ts:282

Create a copy of this DiceFace.

Returns​

VMobject

Overrides​

VGroup._createCopy

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: core/VGroup.ts:456

Create the Three.js backing object for this VGroup. A VGroup is simply a THREE.Group that contains children.

Returns​

Object3D

Inherited from​

VGroup._createThreeObject

_disposeRenderingResources()​

protected _disposeRenderingResources(): void

Defined in: core/VMobjectRendering.ts:613

Returns​

void

Inherited from​

VGroup._disposeRenderingResources

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

VGroup._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

VGroup._getEdgeInDirection

_interpolatePointList3D()​

protected _interpolatePointList3D(points, targetCount): number[][]

Defined in: core/VMobject.ts:448

Interpolate a 3D point list to have a specific number of points.

Parameters​

points​

number[][]

targetCount​

number

Returns​

number[][]

Inherited from​

VGroup._interpolatePointList3D

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns​

void

Inherited from​

VGroup._markDirty

_markDirtyUpward()​

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns​

void

Inherited from​

VGroup._markDirtyUpward

_pointsToCurvePath()​

protected _pointsToCurvePath(): CurvePath<Vector3>

Defined in: core/VMobjectRendering.ts:200

Returns​

CurvePath<Vector3>

Inherited from​

VGroup._pointsToCurvePath

_pointsToShape()​

protected _pointsToShape(): Shape

Defined in: core/VMobjectRendering.ts:196

Returns​

Shape

Inherited from​

VGroup._pointsToShape

_setSceneContext()​

_setSceneContext(rendererWidth, rendererHeight, frameWidth): void

Defined in: core/VMobjectRendering.ts:109

Set per-instance scene context for multi-scene support. Called by Scene when a VMobject is added or the scene is resized.

Parameters​

rendererWidth​

number

rendererHeight​

number

frameWidth​

number

Returns​

void

Inherited from​

VGroup._setSceneContext

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: core/VMobjectRendering.ts:555

Returns​

void

Inherited from​

VGroup._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns​

void

Inherited from​

VGroup._syncToThree

_updateGeometry()​

protected _updateGeometry(group): void

Defined in: core/VMobjectRendering.ts:245

Update the geometry within the Three.js group.

Parameters​

group​

Group

Returns​

void

Inherited from​

VGroup._updateGeometry

[iterator]()​

[iterator](): Iterator<VMobject>

Defined in: core/VGroup.ts:494

Iterate over all vmobjects in the group.

Returns​

Iterator<VMobject>

Inherited from​

VGroup.[iterator]

add()​

add(...mobjects): this

Defined in: core/VGroup.ts:56

Add mobjects to this group (override from Mobject).

Parameters​

mobjects​

...Mobject[]

Mobjects to add

Returns​

this

this for chaining

Inherited from​

VGroup.add

addPoints()​

addPoints(...points): this

Defined in: core/VMobject.ts:168

Add points to this VMobject using 2D Point objects

Parameters​

points​

...Point[]

Returns​

this

Inherited from​

VGroup.addPoints

addPointsAsCorners()​

addPointsAsCorners(corners): this

Defined in: core/VMobject.ts:223

Add straight line segments from the last point to each corner. Each corner creates a new cubic Bezier segment with linear handles. Matches Manim's add_points_as_corners.

Parameters​

corners​

number[][]

Array of [x, y, z] corner points to connect to

Returns​

this

this for chaining

Inherited from​

VGroup.addPointsAsCorners

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

VGroup.addUpdater

addVMobjects()​

addVMobjects(...vmobjects): this

Defined in: core/VGroup.ts:38

Add VMobjects to this group. Accepts VMobjects or arrays of VMobjects.

Parameters​

vmobjects​

...(VMobject | VMobject[])[]

VMobjects to add

Returns​

this

this for chaining

Inherited from​

VGroup.addVMobjects

alignPoints()​

alignPoints(target): void

Defined in: core/VMobject.ts:322

Align points between this VMobject and a target so they have the same count, consistent winding, and optimal rotation for smooth morphing.

Parameters​

target​

VMobject

The target VMobject to align with

Returns​

void

Inherited from​

VGroup.alignPoints

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

VGroup.alignTo

applyFunction()​

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters​

fn​

(point) => number[]

Returns​

this

Inherited from​

VGroup.applyFunction

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

VGroup.applyToFamily

arrange()​

arrange(direction, buff, center): this

Defined in: core/VGroup.ts:356

Arrange children in a row or column with specified spacing.

Parameters​

direction​

Vector3Tuple = RIGHT

Direction to arrange (e.g., RIGHT for row, DOWN for column)

buff​

number = 0.25

Buffer/spacing between children, default 0.25

center​

boolean = true

Whether to center the arrangement at the group's position, default true

Returns​

this

this for chaining

Inherited from​

VGroup.arrange

arrangeInGrid()​

arrangeInGrid(rows?, cols?, buffX?, buffY?): this

Defined in: core/VGroup.ts:387

Arrange children in a grid layout.

Parameters​

rows?​

number

Number of rows (if not specified, auto-calculated)

cols?​

number

Number of columns (if not specified, auto-calculated)

buffX?​

number = 0.25

Horizontal buffer between elements, default 0.25

buffY?​

number = 0.25

Vertical buffer between elements, default 0.25

Returns​

this

this for chaining

Inherited from​

VGroup.arrangeInGrid

become()​

become(other): this

Defined in: core/Mobject.ts:294

Parameters​

other​

Mobject

Returns​

this

Inherited from​

VGroup.become

center()​

center(): this

Defined in: core/Mobject.ts:397

Returns​

this

Inherited from​

VGroup.center

clearPoints()​

clearPoints(): this

Defined in: core/VMobject.ts:257

Clear all points

Returns​

this

Inherited from​

VGroup.clearPoints

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns​

this

Inherited from​

VGroup.clearUpdaters

copy()​

copy(): VMobject

Defined in: core/VMobject.ts:496

Create a copy of this VMobject. Subclasses override _createCopy() to produce an instance of the right concrete type (Circle, Square, etc.), but those constructors typically regenerate points from their own parameters (radius, sideLength, ...). After a Transform animation has morphed the point data, the regenerated points no longer match the actual visual state. We therefore always overwrite the clone's _points3D with the source's current data.

Returns​

VMobject

Inherited from​

VGroup.copy

dispose()​

dispose(): void

Defined in: core/VMobject.ts:616

Clean up Three.js resources

Returns​

void

Inherited from​

VGroup.dispose

filter()​

filter(fn): VGroup

Defined in: core/VGroup.ts:522

Filter vmobjects in the group.

Parameters​

fn​

(vmobject, index) => boolean

Filter predicate

Returns​

VGroup

New VGroup with filtered vmobjects

Inherited from​

VGroup.filter

flip()​

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters​

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

VGroup.flip

forEach()​

forEach(fn): this

Defined in: core/VGroup.ts:503

Apply a function to each vmobject in the group.

Parameters​

fn​

(vmobject, index) => void

Function to apply

Returns​

this

this for chaining

Inherited from​

VGroup.forEach

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns​

Mobject

Inherited from​

VGroup.generateTarget

get()​

get(index): VMobject

Defined in: core/VGroup.ts:487

Get a vmobject by index.

Parameters​

index​

number

Index of the vmobject

Returns​

VMobject

The vmobject at the given index, or undefined

Inherited from​

VGroup.get

getBackground()​

getBackground(): RoundedRectangle

Defined in: mobjects/probability/DiceFace.ts:222

Get the background rectangle.

Returns​

RoundedRectangle

getBackgroundColor()​

getBackgroundColor(): string

Defined in: mobjects/probability/DiceFace.ts:263

Get the background color.

Returns​

string

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns​

Vector3Tuple

Inherited from​

VGroup.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

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

VGroup.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/VGroup.ts:137

Get the center of the group (average of all children centers).

Returns​

Vector3Tuple

Center position as [x, y, z]

Inherited from​

VGroup.getCenter

getCombinedPoints()​

getCombinedPoints(): number[][]

Defined in: core/VGroup.ts:442

Get combined path points from all children.

Returns​

number[][]

Combined array of points from all children

Inherited from​

VGroup.getCombinedPoints

getDotColor()​

getDotColor(): string

Defined in: mobjects/probability/DiceFace.ts:243

Get the dot color.

Returns​

string

getDots()​

getDots(): Dot[]

Defined in: mobjects/probability/DiceFace.ts:229

Get all the dot mobjects.

Returns​

Dot[]

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

VGroup.getEdge

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns​

Mobject[]

Inherited from​

VGroup.getFamily

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns​

Vector3Tuple

Inherited from​

VGroup.getLeft

getPoints()​

getPoints(): number[][]

Defined in: core/VGroup.ts:544

Get all 3D points from the VGroup.

Returns​

number[][]

Inherited from​

VGroup.getPoints

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns​

Vector3Tuple

Inherited from​

VGroup.getRight

getSize()​

getSize(): number

Defined in: mobjects/probability/DiceFace.ts:236

Get the size (side length) of the die face.

Returns​

number

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns​

Object3D

Inherited from​

VGroup.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns​

Vector3Tuple

Inherited from​

VGroup.getTop

getUnitVector()​

getUnitVector(): Vector3Tuple

Defined in: core/VMobject.ts:524

Get the unit vector from the first to the last point of this VMobject, accounting for the object's current rotation transform.

Returns​

Vector3Tuple

Inherited from​

VGroup.getUnitVector

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns​

UpdaterFunction[]

Inherited from​

VGroup.getUpdaters

getValue()​

getValue(): number

Defined in: mobjects/probability/DiceFace.ts:193

Get the face value (1-6).

Returns​

number

getVisiblePointCount()​

getVisiblePointCount(): number

Defined in: core/VMobject.ts:157

Get the visible point count (null means all points visible).

Returns​

number

Inherited from​

VGroup.getVisiblePointCount

getVisiblePoints()​

getVisiblePoints(): Point[]

Defined in: core/VMobject.ts:131

Get points that should be visible (for rendering) as 2D Points

Returns​

Point[]

Inherited from​

VGroup.getVisiblePoints

getVisiblePoints3D()​

getVisiblePoints3D(): number[][]

Defined in: core/VMobject.ts:139

Get points that should be visible (for rendering) as 3D arrays

Returns​

number[][]

Inherited from​

VGroup.getVisiblePoints3D

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns​

boolean

Inherited from​

VGroup.hasUpdaters

interpolate()​

interpolate(target, alpha): this

Defined in: core/VMobject.ts:275

Interpolate this VMobject towards a target VMobject

Parameters​

target​

VMobject

The target VMobject to interpolate towards

alpha​

number

Progress from 0 (this) to 1 (target)

Returns​

this

this for chaining

Inherited from​

VGroup.interpolate

map()​

map<T>(fn): T[]

Defined in: core/VGroup.ts:513

Map over all vmobjects in the group.

Type Parameters​

T​

T

Parameters​

fn​

(vmobject, index) => T

Mapping function

Returns​

T[]

Array of mapped values

Inherited from​

VGroup.map

markGeometryDirty()​

markGeometryDirty(): void

Defined in: core/VMobjectRendering.ts:180

Mark geometry as needing rebuild on next render.

Returns​

void

Inherited from​

VGroup.markGeometryDirty

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/VGroup.ts:181

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​

VGroup.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

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

VGroup.nextTo

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

VGroup.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/VGroup.ts:117

Remove mobjects from this group (override from Mobject).

Parameters​

mobjects​

...Mobject[]

Mobjects to remove

Returns​

this

this for chaining

Inherited from​

VGroup.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

VGroup.removeUpdater

removeVMobjects()​

removeVMobjects(...vmobjects): this

Defined in: core/VGroup.ts:96

Remove VMobjects from this group.

Parameters​

vmobjects​

...VMobject[]

VMobjects to remove

Returns​

this

this for chaining

Inherited from​

VGroup.removeVMobjects

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

VGroup.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns​

boolean

Inherited from​

VGroup.restoreState

rotate()​

rotate(angle, axis): this

Defined in: core/VGroup.ts:211

Rotate all children around an axis.

Parameters​

angle​

number

Rotation angle in radians

axis​

Vector3Tuple = ...

Axis of rotation [x, y, z], defaults to Z axis

Returns​

this

this for chaining

Inherited from​

VGroup.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

VGroup.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:521

Returns​

this

Inherited from​

VGroup.saveState

scale()​

scale(factor): this

Defined in: core/VGroup.ts:231

Scale all children about the group's center. Each child's size is scaled, and their positions are repositioned relative to the group center — matching Manim Python behavior. Does not change the group's own scaleVector.

Parameters​

factor​

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

number | Vector3Tuple

Returns​

this

this for chaining

Inherited from​

VGroup.scale

setBackgroundColor()​

setBackgroundColor(color): this

Defined in: mobjects/probability/DiceFace.ts:272

Set the background color.

Parameters​

color​

string

CSS color string

Returns​

this

this for chaining

setColor()​

setColor(color): this

Defined in: core/VGroup.ts:257

Set the color of all children.

Parameters​

color​

string

CSS color string

Returns​

this

this for chaining

Inherited from​

VGroup.setColor

setDotColor()​

setDotColor(color): this

Defined in: mobjects/probability/DiceFace.ts:252

Set the dot color for all pips.

Parameters​

color​

string

CSS color string

Returns​

this

this for chaining

setFill()​

setFill(color?, opacity?): this

Defined in: core/VGroup.ts:311

Set the fill color of all children.

Parameters​

color?​

string

CSS color string

opacity?​

number

Returns​

this

this for chaining

Inherited from​

VGroup.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/VGroup.ts:296

Set the fill opacity of all children.

Parameters​

opacity​

number

Fill opacity (0-1)

Returns​

this

this for chaining

Inherited from​

VGroup.setFillOpacity

setOpacity()​

setOpacity(opacity): this

Defined in: core/VGroup.ts:270

Set the opacity of all children.

Parameters​

opacity​

number

Opacity value (0-1)

Returns​

this

this for chaining

Inherited from​

VGroup.setOpacity

setPoints()​

setPoints(points): this

Defined in: core/VMobject.ts:68

Set the points defining this VMobject. Accepts either Point[] ({x, y} objects) or number[][] ([x, y, z] arrays).

Parameters​

points​

Array of points in either format

number[][] | Point[]

Returns​

this

this for chaining

Inherited from​

VGroup.setPoints

setPoints3D()​

setPoints3D(points): this

Defined in: core/VMobject.ts:93

Set the points defining this VMobject using 3D arrays (alias for setPoints with number[][])

Parameters​

points​

number[][]

Array of [x, y, z] control points for cubic Bezier curves

Returns​

this

this for chaining

Inherited from​

VGroup.setPoints3D

setPointsAsCorners()​

setPointsAsCorners(corners): this

Defined in: core/VMobject.ts:182

Set the points to form straight line segments between corner points. Each pair of consecutive corners becomes a cubic Bezier with linear handles. Matches Manim's set_points_as_corners.

Parameters​

corners​

number[][]

Array of [x, y, z] corner points

Returns​

this

this for chaining

Inherited from​

VGroup.setPointsAsCorners

setStroke()​

setStroke(color?, width?, opacity?): this

Defined in: core/VGroup.ts:332

Set the stroke of all children.

Parameters​

color?​

string

CSS color string

width?​

number

Stroke width in pixels

opacity?​

number

Stroke opacity (0-1)

Returns​

this

this for chaining

Inherited from​

VGroup.setStroke

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/VGroup.ts:283

Set the stroke width of all children.

Parameters​

width​

number

Stroke width in pixels

Returns​

this

this for chaining

Inherited from​

VGroup.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

VGroup.setStyle

setValue()​

setValue(value): this

Defined in: mobjects/probability/DiceFace.ts:202

Set the face value, recreating the dots.

Parameters​

value​

number

New face value (1-6)

Returns​

this

this for chaining

setVisiblePointCount()​

setVisiblePointCount(count): void

Defined in: core/VMobject.ts:148

Set visible point count for progressive creation animations. Use null to show all points.

Parameters​

count​

number

Returns​

void

Inherited from​

VGroup.setVisiblePointCount

setX()​

setX(x): this

Defined in: core/Mobject.ts:385

Parameters​

x​

number

Returns​

this

Inherited from​

VGroup.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:389

Parameters​

y​

number

Returns​

this

Inherited from​

VGroup.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters​

z​

number

Returns​

this

Inherited from​

VGroup.setZ

shift()​

shift(delta): this

Defined in: core/VGroup.ts:167

Shift all children by the given delta. Only shifts children's internal positions, not the group's own position, to avoid double-counting in THREE.js hierarchy.

Parameters​

delta​

Vector3Tuple

Translation vector [x, y, z]

Returns​

this

this for chaining

Inherited from​

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

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

VGroup.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:497

Parameters​

dt​

number

Returns​

void

Inherited from​

VGroup.update

_toLinewidth()​

static _toLinewidth(this, strokeWidth): number

Defined in: core/VMobjectRendering.ts:123

Convert Manim-compatible strokeWidth to LineMaterial linewidth in pixels. Python Manim uses cairo_line_width_multiple=0.01, so: linewidth_px = strokeWidth * 0.01 * (rendererWidth / frameWidth)

NOTE: This static method uses class-level statics. For multi-scene correctness, internal code should use the instance method _computeLinewidth().

Parameters​

this​

typeof VMobjectRendering

strokeWidth​

number

Returns​

number

Inherited from​

VGroup._toLinewidth