Skip to main content

Class: Octahedron

Defined in: mobjects/three-d/Polyhedra.ts:284

Octahedron - An 8-faced polyhedron (platonic solid)

Creates an octahedron using Three.js OctahedronGeometry with configurable size and material properties. Essentially two square pyramids base-to-base.

Example​

// Create a unit octahedron
const octa = new Octahedron();

// Create a blue octahedron with side length 2
const blueOcta = new Octahedron({ sideLength: 2, color: '#0000ff' });

// Create a semi-transparent octahedron
const transparent = new Octahedron({ sideLength: 1.5, opacity: 0.5 });

Extends​

Constructors​

Constructor​

new Octahedron(options): Octahedron

Defined in: mobjects/three-d/Polyhedra.ts:40

Parameters​

options​

PolyhedronOptions = {}

Returns​

Octahedron

Inherited from​

Polyhedron.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from​

Polyhedron.__savedMobjectState

_centerPoint​

protected _centerPoint: Vector3Tuple

Defined in: mobjects/three-d/Polyhedra.ts:37

Inherited from​

Polyhedron._centerPoint

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from​

Polyhedron._color

_detail​

protected _detail: number

Defined in: mobjects/three-d/Polyhedra.ts:38

Inherited from​

Polyhedron._detail

_dirty​

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from​

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

Polyhedron._disableChildZLayering

_opacity​

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from​

Polyhedron._opacity

_sideLength​

protected _sideLength: number

Defined in: mobjects/three-d/Polyhedra.ts:35

Inherited from​

Polyhedron._sideLength

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from​

Polyhedron._style

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from​

Polyhedron._threeObject

_wireframe​

protected _wireframe: boolean

Defined in: mobjects/three-d/Polyhedra.ts:36

Inherited from​

Polyhedron._wireframe

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from​

Polyhedron.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from​

Polyhedron.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from​

Polyhedron.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from​

Polyhedron.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from​

Polyhedron.parent

position​

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from​

Polyhedron.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from​

Polyhedron.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from​

Polyhedron.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from​

Polyhedron.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from​

Polyhedron.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

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

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

Polyhedron.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns​

boolean

Inherited from​

Polyhedron.isDirty

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​

Polyhedron.opacity

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns​

MobjectStyle

Inherited from​

Polyhedron.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns​

Mobject[]

Inherited from​

Polyhedron.submobjects

Methods​

_createCopy()​

protected _createCopy(): Octahedron

Defined in: mobjects/three-d/Polyhedra.ts:324

Returns​

Octahedron

Overrides​

Polyhedron._createCopy

_createGeometry()​

protected _createGeometry(): BufferGeometry

Defined in: mobjects/three-d/Polyhedra.ts:293

Create the Three.js geometry for this polyhedron. Subclasses must implement this.

Returns​

BufferGeometry

Overrides​

Polyhedron._createGeometry

_createThreeObject()​

protected _createThreeObject(): Object3D

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

Create the Three.js mesh

Returns​

Object3D

Inherited from​

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

Polyhedron._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Polyhedron._getEdgeInDirection

_getRadiusFromSideLength()​

protected _getRadiusFromSideLength(): number

Defined in: mobjects/three-d/Polyhedra.ts:289

Convert side length to circumradius for Three.js OctahedronGeometry. For an octahedron: circumradius = sideLength / sqrt(2)

Returns​

number

Overrides​

Polyhedron._getRadiusFromSideLength

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns​

void

Inherited from​

Polyhedron._markDirty

_markDirtyUpward()​

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns​

void

Inherited from​

Polyhedron._markDirtyUpward

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: mobjects/three-d/Polyhedra.ts:98

Sync material properties to Three.js object

Returns​

void

Inherited from​

Polyhedron._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns​

void

Inherited from​

Polyhedron._syncToThree

_updateGeometry()​

protected _updateGeometry(): void

Defined in: mobjects/three-d/Polyhedra.ts:114

Update the geometry with current dimensions

Returns​

void

Inherited from​

Polyhedron._updateGeometry

add()​

add(...mobjects): this

Defined in: core/Mobject.ts:247

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Polyhedron.add

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

Polyhedron.addUpdater

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

Polyhedron.alignTo

applyFunction()​

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters​

fn​

(point) => number[]

Returns​

this

Inherited from​

Polyhedron.applyFunction

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

Polyhedron.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:294

Parameters​

other​

Mobject

Returns​

this

Inherited from​

Polyhedron.become

center()​

center(): this

Defined in: core/Mobject.ts:397

Returns​

this

Inherited from​

Polyhedron.center

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns​

this

Inherited from​

Polyhedron.clearUpdaters

copy()​

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns​

Mobject

Inherited from​

Polyhedron.copy

dispose()​

dispose(): void

Defined in: core/Mobject.ts:532

Returns​

void

Inherited from​

Polyhedron.dispose

flip()​

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters​

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Polyhedron.flip

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns​

Mobject

Inherited from​

Polyhedron.generateTarget

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: core/Mobject.ts:363

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Inherited from​

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

Polyhedron.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/Mobject.ts:306

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getCenter

getDetail()​

getDetail(): number

Defined in: mobjects/three-d/Polyhedra.ts:157

Get the detail level

Returns​

number

Inherited from​

Polyhedron.getDetail

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getEdge

getEdgeCount()​

getEdgeCount(): number

Defined in: mobjects/three-d/Polyhedra.ts:306

Get the number of edges for this polyhedron

Returns​

number

Overrides​

Polyhedron.getEdgeCount

getFaceCount()​

getFaceCount(): number

Defined in: mobjects/three-d/Polyhedra.ts:298

Get the number of faces for this polyhedron

Returns​

number

Overrides​

Polyhedron.getFaceCount

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns​

Mobject[]

Inherited from​

Polyhedron.getFamily

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getLeft

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getRight

getSideLength()​

getSideLength(): number

Defined in: mobjects/three-d/Polyhedra.ts:125

Get the side length

Returns​

number

Inherited from​

Polyhedron.getSideLength

getSurfaceArea()​

getSurfaceArea(): number

Defined in: mobjects/three-d/Polyhedra.ts:313

Get the surface area of the octahedron

Returns​

number

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns​

Object3D

Inherited from​

Polyhedron.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns​

Vector3Tuple

Inherited from​

Polyhedron.getTop

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns​

UpdaterFunction[]

Inherited from​

Polyhedron.getUpdaters

getVertexCount()​

getVertexCount(): number

Defined in: mobjects/three-d/Polyhedra.ts:302

Get the number of vertices for this polyhedron

Returns​

number

Overrides​

Polyhedron.getVertexCount

getVolume()​

getVolume(): number

Defined in: mobjects/three-d/Polyhedra.ts:320

Get the volume of the octahedron

Returns​

number

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns​

boolean

Inherited from​

Polyhedron.hasUpdaters

isWireframe()​

isWireframe(): boolean

Defined in: mobjects/three-d/Polyhedra.ts:141

Get whether wireframe mode is enabled

Returns​

boolean

Inherited from​

Polyhedron.isWireframe

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/Mobject.ts:192

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

Polyhedron.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

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

Polyhedron.nextTo

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

Polyhedron.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/Mobject.ts:260

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Polyhedron.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

Polyhedron.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

Polyhedron.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns​

boolean

Inherited from​

Polyhedron.restoreState

rotate()​

rotate(angle, axisOrOptions?): this

Defined in: core/Mobject.ts:213

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

Parameters​

angle​

number

axisOrOptions?​

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

Returns​

this

Inherited from​

Polyhedron.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Polyhedron.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:521

Returns​

this

Inherited from​

Polyhedron.saveState

scale()​

scale(factor): this

Defined in: core/Mobject.ts:233

Parameters​

factor​

number | Vector3Tuple

Returns​

this

Inherited from​

Polyhedron.scale

setColor()​

setColor(color): this

Defined in: core/Mobject.ts:127

Parameters​

color​

string

Returns​

this

Inherited from​

Polyhedron.setColor

setDetail()​

setDetail(value): this

Defined in: mobjects/three-d/Polyhedra.ts:164

Set the detail level (subdivision)

Parameters​

value​

number

Returns​

this

Inherited from​

Polyhedron.setDetail

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

Polyhedron.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:155

Parameters​

opacity​

number

Returns​

this

Inherited from​

Polyhedron.setFillOpacity

setOpacity()​

setOpacity(opacity): this

Defined in: core/Mobject.ts:135

Parameters​

opacity​

number

Returns​

this

Inherited from​

Polyhedron.setOpacity

setSideLength()​

setSideLength(value): this

Defined in: mobjects/three-d/Polyhedra.ts:132

Set the side length

Parameters​

value​

number

Returns​

this

Inherited from​

Polyhedron.setSideLength

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Mobject.ts:145

Parameters​

width​

number

Returns​

this

Inherited from​

Polyhedron.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

Polyhedron.setStyle

setWireframe()​

setWireframe(value): this

Defined in: mobjects/three-d/Polyhedra.ts:148

Set wireframe mode

Parameters​

value​

boolean

Returns​

this

Inherited from​

Polyhedron.setWireframe

setX()​

setX(x): this

Defined in: core/Mobject.ts:385

Parameters​

x​

number

Returns​

this

Inherited from​

Polyhedron.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:389

Parameters​

y​

number

Returns​

this

Inherited from​

Polyhedron.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters​

z​

number

Returns​

this

Inherited from​

Polyhedron.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:184

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

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

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

Polyhedron.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:497

Parameters​

dt​

number

Returns​

void

Inherited from​

Polyhedron.update