Class: BraceText

Defined in: mobjects/svg/Brace.ts:1136

BraceText - Alias for BraceLabel with text

A convenience class that is identical to BraceLabel. Provided for API compatibility with Manim.

Example

// These are equivalent:
const brace1 = new BraceLabel(mobject, { label: 'text' });
const brace2 = new BraceText(mobject, 'text');

Extends

• BraceLabel

Constructors

Constructor

new BraceText(mobject, text, options): BraceText

Defined in: mobjects/svg/Brace.ts:1137

Parameters

mobject

Mobject

text

string

options

Omit<BraceLabelOptions, "label"> = {}

Returns

BraceText

Overrides

BraceLabel.constructor

Properties

__savedMobjectState

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from

BraceLabel.__savedMobjectState

---

_brace

protected _brace: Brace

Defined in: mobjects/svg/Brace.ts:1018

Inherited from

BraceLabel._brace

---

_color

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from

BraceLabel._color

---

_dirty

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from

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

BraceLabel._disableChildZLayering

---

_label

protected _label: Mobject

Defined in: mobjects/svg/Brace.ts:1019

Inherited from

BraceLabel._label

---

_labelBuff

protected _labelBuff: number

Defined in: mobjects/svg/Brace.ts:1020

Inherited from

BraceLabel._labelBuff

---

_opacity

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from

BraceLabel._opacity

---

_style

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from

BraceLabel._style

---

_threeObject

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from

BraceLabel._threeObject

---

children

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from

BraceLabel.children

---

createdAtBeginning

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from

BraceLabel.createdAtBeginning

---

fillOpacity

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from

BraceLabel.fillOpacity

---

id

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from

BraceLabel.id

---

parent

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from

BraceLabel.parent

---

position

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from

BraceLabel.position

---

rotation

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from

BraceLabel.rotation

---

savedState

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from

BraceLabel.savedState

---

scaleVector

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from

BraceLabel.scaleVector

---

strokeWidth

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from

BraceLabel.strokeWidth

---

targetCopy

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from

BraceLabel.targetCopy

Accessors

color

Get Signature

get color(): string

Defined in: core/Mobject.ts:58

Returns

string

Set Signature

set color(value): void

Defined in: core/Mobject.ts:61

Parameters

value

string

Returns

void

Inherited from

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

BraceLabel.fillColor

---

isDirty

Get Signature

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns

boolean

Inherited from

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

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

BraceLabel.opacity

---

style

Get Signature

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns

MobjectStyle

Inherited from

BraceLabel.style

---

submobjects

Get Signature

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns

Mobject[]

Inherited from

BraceLabel.submobjects

Methods

_createCopy()

protected _createCopy(): BraceText

Defined in: mobjects/svg/Brace.ts:1144

Create a copy of this BraceText

Returns

BraceText

Overrides

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

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

BraceLabel._getBoundingBox

---

_getEdgeInDirection()

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

BraceLabel._getEdgeInDirection

---

_markDirty()

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns

void

Inherited from

BraceLabel._markDirty

---

_markDirtyUpward()

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns

void

Inherited from

BraceLabel._markDirtyUpward

---

_positionLabel()

protected _positionLabel(): void

Defined in: mobjects/svg/Brace.ts:1070

Position the label at the tip of the brace

Returns

void

Inherited from

BraceLabel._positionLabel

---

_syncMaterialToThree()

protected _syncMaterialToThree(): void

Defined in: core/Mobject.ts:436

Returns

void

Inherited from

BraceLabel._syncMaterialToThree

---

_syncToThree()

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns

void

Inherited from

BraceLabel._syncToThree

---

[iterator]()

[iterator](): Iterator<Mobject>

Defined in: core/Group.ts:276

Iterate over all mobjects in the group.

Returns

Iterator<Mobject>

Inherited from

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

BraceLabel.add

---

addUpdater()

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters

updater

UpdaterFunction

callOnAdd

boolean = false

Returns

this

Inherited from

BraceLabel.addUpdater

---

alignTo()

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters

target

Mobject | Vector3Tuple

direction

Vector3Tuple

Returns

this

Inherited from

BraceLabel.alignTo

---

applyFunction()

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters

fn

(point) => number[]

Returns

this

Inherited from

BraceLabel.applyFunction

---

applyToFamily()

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters

func

(mobject) => void

Returns

this

Inherited from

BraceLabel.applyToFamily

---

become()

become(other): this

Defined in: core/Mobject.ts:294

Parameters

other

Mobject

Returns

this

Inherited from

BraceLabel.become

---

center()

center(): this

Defined in: core/Mobject.ts:397

Returns

this

Inherited from

BraceLabel.center

---

clear()

clear(): this

Defined in: core/Group.ts:73

Remove all children from this group.

Returns

this

this for chaining

Inherited from

BraceLabel.clear

---

clearUpdaters()

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns

this

Inherited from

BraceLabel.clearUpdaters

---

copy()

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns

Mobject

Inherited from

BraceLabel.copy

---

dispose()

dispose(): void

Defined in: core/Mobject.ts:532

Returns

void

Inherited from

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

BraceLabel.filter

---

flip()

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters

axis

Vector3Tuple = ...

Returns

this

Inherited from

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

BraceLabel.forEach

---

generateTarget()

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns

Mobject

Inherited from

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

BraceLabel.get

---

getBottom()

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns

Vector3Tuple

Inherited from

BraceLabel.getBottom

---

getBoundingBox()

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns

object

depth

depth: number

height

height: number

width

width: number

Inherited from

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

BraceLabel.getBounds

---

getBrace()

getBrace(): Brace

Defined in: mobjects/svg/Brace.ts:1087

Get the brace component

Returns

Brace

Inherited from

BraceLabel.getBrace

---

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

BraceLabel.getCenter

---

getEdge()

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters

direction

Vector3Tuple

Returns

Vector3Tuple

Inherited from

BraceLabel.getEdge

---

getFamily()

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns

Mobject[]

Inherited from

BraceLabel.getFamily

---

getLabel()

getLabel(): Mobject

Defined in: mobjects/svg/Brace.ts:1094

Get the label component

Returns

Mobject

Inherited from

BraceLabel.getLabel

---

getLeft()

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns

Vector3Tuple

Inherited from

BraceLabel.getLeft

---

getRight()

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns

Vector3Tuple

Inherited from

BraceLabel.getRight

---

getThreeObject()

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns

Object3D

Inherited from

BraceLabel.getThreeObject

---

getTip()

getTip(): Vector3Tuple

Defined in: mobjects/svg/Brace.ts:1101

Get the tip point of the brace

Returns

Vector3Tuple

Inherited from

BraceLabel.getTip

---

getTop()

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns

Vector3Tuple

Inherited from

BraceLabel.getTop

---

getUpdaters()

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns

UpdaterFunction[]

Inherited from

BraceLabel.getUpdaters

---

hasUpdaters()

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns

boolean

Inherited from

BraceLabel.hasUpdaters

---

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

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

BraceLabel.moveTo

---

moveToAligned()

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters

target

Mobject | Vector3Tuple

alignedEdge?

Vector3Tuple

Returns

this

Inherited from

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

BraceLabel.nextTo

---

prepareForNonlinearTransform()

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters

numPieces

number = 50

Returns

this

Inherited from

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

BraceLabel.remove

---

removeUpdater()

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters

updater

UpdaterFunction

Returns

this

Inherited from

BraceLabel.removeUpdater

---

replace()

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters

target

Mobject

stretch

boolean = false

Returns

this

Inherited from

BraceLabel.replace

---

restoreState()

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns

boolean

Inherited from

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

BraceLabel.rotate

---

rotateAboutOrigin()

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters

angle

number

axis

Vector3Tuple = ...

Returns

this

Inherited from

BraceLabel.rotateAboutOrigin

---

saveState()

saveState(): this

Defined in: core/Mobject.ts:521

Returns

this

Inherited from

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

BraceLabel.scale

---

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

BraceLabel.setColor

---

setFill()

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters

color?

string

opacity?

number

Returns

this

Inherited from

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

BraceLabel.setFillOpacity

---

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

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

BraceLabel.setStrokeWidth

---

setStyle()

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters

style

Partial<MobjectStyle>

Returns

this

Inherited from

BraceLabel.setStyle

---

setX()

setX(x): this

Defined in: core/Mobject.ts:385

Parameters

x

number

Returns

this

Inherited from

BraceLabel.setX

---

setY()

setY(y): this

Defined in: core/Mobject.ts:389

Parameters

y

number

Returns

this

Inherited from

BraceLabel.setY

---

setZ()

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters

z

number

Returns

this

Inherited from

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

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

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

BraceLabel.toEdge

---

update()

update(dt): void

Defined in: core/Mobject.ts:497

Parameters

dt

number

Returns

void

Inherited from

BraceLabel.update