Skip to main content

Class: ImageMobject

Defined in: mobjects/image/index.ts:75

ImageMobject - Display images as mobjects

Creates an image plane using THREE.js PlaneGeometry with TextureLoader. Supports loading from URLs or base64 data, with optional filters like grayscale and invert.

Example​

// Load from URL
const image = new ImageMobject({
  source: 'https://example.com/image.png',
  width: 4,
});

// Load from base64
const base64Image = new ImageMobject({
  source: 'data:image/png;base64,iVBORw0KGgoAAAA...',
  height: 3,
  opacity: 0.8,
});

// With filters
const filtered = new ImageMobject({
  source: 'https://example.com/photo.jpg',
  width: 5,
  filters: {
    grayscale: true,
    brightness: 1.2,
  },
});

Extends​

Constructors​

Constructor​

new ImageMobject(options): ImageMobject

Defined in: mobjects/image/index.ts:94

Parameters​

options​

ImageMobjectOptions

Returns​

ImageMobject

Overrides​

Mobject.constructor

Properties​

__savedMobjectState​

__savedMobjectState: unknown = null

Defined in: core/Mobject.ts:82

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

Inherited from​

Mobject.__savedMobjectState

_centerPoint​

protected _centerPoint: Vector3Tuple

Defined in: mobjects/image/index.ts:81

_color​

protected _color: string = '#ffffff'

Defined in: core/Mobject.ts:57

Inherited from​

Mobject._color

_dirty​

_dirty: boolean = true

Defined in: core/Mobject.ts:75

Inherited from​

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

Mobject._disableChildZLayering

_doubleSided​

protected _doubleSided: boolean

Defined in: mobjects/image/index.ts:83

_filters​

protected _filters: ImageFilterOptions

Defined in: mobjects/image/index.ts:82

_height​

protected _height: number

Defined in: mobjects/image/index.ts:79

_imageLoaded​

protected _imageLoaded: boolean = false

Defined in: mobjects/image/index.ts:85

_naturalHeight​

protected _naturalHeight: number = 1

Defined in: mobjects/image/index.ts:87

_naturalWidth​

protected _naturalWidth: number = 1

Defined in: mobjects/image/index.ts:86

_opacity​

protected _opacity: number = 1

Defined in: core/Mobject.ts:68

Inherited from​

Mobject._opacity

_pixelData​

protected _pixelData: number[][]

Defined in: mobjects/image/index.ts:77

_scaleToFit​

protected _scaleToFit: boolean

Defined in: mobjects/image/index.ts:80

_source​

protected _source: string

Defined in: mobjects/image/index.ts:76

_style​

protected _style: MobjectStyle

Defined in: core/Mobject.ts:73

Inherited from​

Mobject._style

_texture​

protected _texture: Texture<unknown> = null

Defined in: mobjects/image/index.ts:84

_threeObject​

_threeObject: Object3D<Object3DEventMap> = null

Defined in: core/Mobject.ts:74

Inherited from​

Mobject._threeObject

_width​

protected _width: number

Defined in: mobjects/image/index.ts:78

children​

children: Mobject[] = []

Defined in: core/Mobject.ts:52

Inherited from​

Mobject.children

createdAtBeginning​

createdAtBeginning: boolean = false

Defined in: core/Mobject.ts:56

Inherited from​

Mobject.createdAtBeginning

fillOpacity​

fillOpacity: number = 0

Defined in: core/Mobject.ts:70

Inherited from​

Mobject.fillOpacity

id​

readonly id: string

Defined in: core/Mobject.ts:50

Inherited from​

Mobject.id

parent​

parent: Mobject = null

Defined in: core/Mobject.ts:51

Inherited from​

Mobject.parent

position​

position: Vector3

Defined in: core/Mobject.ts:53

Inherited from​

Mobject.position

rotation​

rotation: Euler

Defined in: core/Mobject.ts:54

Inherited from​

Mobject.rotation

savedState​

savedState: Mobject = null

Defined in: core/Mobject.ts:78

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

Inherited from​

Mobject.savedState

scaleVector​

scaleVector: Vector3

Defined in: core/Mobject.ts:55

Inherited from​

Mobject.scaleVector

strokeWidth​

strokeWidth: number = 4

Defined in: core/Mobject.ts:69

Inherited from​

Mobject.strokeWidth

targetCopy​

targetCopy: Mobject = null

Defined in: core/Mobject.ts:80

Target copy used by generateTarget() / MoveToTarget animation.

Inherited from​

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

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

Mobject.fillColor

isDirty​

Get Signature​

get isDirty(): boolean

Defined in: core/Mobject.ts:448

Returns​

boolean

Inherited from​

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

Mobject.opacity

style​

Get Signature​

get style(): MobjectStyle

Defined in: core/Mobject.ts:109

Returns​

MobjectStyle

Inherited from​

Mobject.style

submobjects​

Get Signature​

get submobjects(): Mobject[]

Defined in: core/Mobject.ts:123

Returns​

Mobject[]

Inherited from​

Mobject.submobjects

Methods​

_createCopy()​

protected _createCopy(): ImageMobject

Defined in: mobjects/image/index.ts:639

Create a copy of this ImageMobject

Returns​

ImageMobject

Overrides​

Mobject._createCopy

_createThreeObject()​

protected _createThreeObject(): Object3D

Defined in: mobjects/image/index.ts:402

Create the Three.js plane mesh with image texture

Returns​

Object3D

Overrides​

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

Mobject._getBoundingBox

_getEdgeInDirection()​

_getEdgeInDirection(direction): Vector3Tuple

Defined in: core/Mobject.ts:360

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Mobject._getEdgeInDirection

_markDirty()​

_markDirty(): void

Defined in: core/Mobject.ts:438

Returns​

void

Inherited from​

Mobject._markDirty

_markDirtyUpward()​

_markDirtyUpward(): void

Defined in: core/Mobject.ts:442

Returns​

void

Inherited from​

Mobject._markDirtyUpward

_syncMaterialToThree()​

protected _syncMaterialToThree(): void

Defined in: mobjects/image/index.ts:446

Sync material properties to Three.js object

Returns​

void

Overrides​

Mobject._syncMaterialToThree

_syncToThree()​

_syncToThree(): void

Defined in: core/Mobject.ts:416

Returns​

void

Inherited from​

Mobject._syncToThree

_updateGeometry()​

protected _updateGeometry(): void

Defined in: mobjects/image/index.ts:422

Update geometry when dimensions change

Returns​

void

add()​

add(...mobjects): this

Defined in: core/Mobject.ts:247

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Mobject.add

addUpdater()​

addUpdater(updater, callOnAdd): this

Defined in: core/Mobject.ts:474

Parameters​

updater​

UpdaterFunction

callOnAdd​

boolean = false

Returns​

this

Inherited from​

Mobject.addUpdater

alignTo()​

alignTo(target, direction): this

Defined in: core/Mobject.ts:345

Parameters​

target​

Mobject | Vector3Tuple

direction​

Vector3Tuple

Returns​

this

Inherited from​

Mobject.alignTo

applyFunction()​

applyFunction(fn): this

Defined in: core/Mobject.ts:504

Parameters​

fn​

(point) => number[]

Returns​

this

Inherited from​

Mobject.applyFunction

applyToFamily()​

applyToFamily(func): this

Defined in: core/Mobject.ts:462

Parameters​

func​

(mobject) => void

Returns​

this

Inherited from​

Mobject.applyToFamily

become()​

become(other): this

Defined in: core/Mobject.ts:294

Parameters​

other​

Mobject

Returns​

this

Inherited from​

Mobject.become

center()​

center(): this

Defined in: core/Mobject.ts:397

Returns​

this

Inherited from​

Mobject.center

clearUpdaters()​

clearUpdaters(): this

Defined in: core/Mobject.ts:486

Returns​

this

Inherited from​

Mobject.clearUpdaters

copy()​

copy(): Mobject

Defined in: core/Mobject.ts:276

Returns​

Mobject

Inherited from​

Mobject.copy

dispose()​

dispose(): void

Defined in: mobjects/image/index.ts:656

Clean up resources

Returns​

void

Overrides​

Mobject.dispose

flip()​

flip(axis): this

Defined in: core/Mobject.ts:225

Parameters​

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Mobject.flip

generateTarget()​

generateTarget(): Mobject

Defined in: core/Mobject.ts:516

Returns​

Mobject

Inherited from​

Mobject.generateTarget

getAspectRatio()​

getAspectRatio(): number

Defined in: mobjects/image/index.ts:620

Get the aspect ratio of the image

Returns​

number

getBottom()​

getBottom(): Vector3Tuple

Defined in: core/Mobject.ts:376

Returns​

Vector3Tuple

Inherited from​

Mobject.getBottom

getBoundingBox()​

getBoundingBox(): object

Defined in: mobjects/image/index.ts:627

Override getBoundingBox to use calculated dimensions

Returns​

object

depth​

depth: number

height​

height: number

width​

width: number

Overrides​

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

Mobject.getBounds

getCenter()​

getCenter(): Vector3Tuple

Defined in: core/Mobject.ts:306

Returns​

Vector3Tuple

Inherited from​

Mobject.getCenter

getEdge()​

getEdge(direction): Vector3Tuple

Defined in: core/Mobject.ts:370

Parameters​

direction​

Vector3Tuple

Returns​

Vector3Tuple

Inherited from​

Mobject.getEdge

getFamily()​

getFamily(): Mobject[]

Defined in: core/Mobject.ts:468

Returns​

Mobject[]

Inherited from​

Mobject.getFamily

getFilters()​

getFilters(): ImageFilterOptions

Defined in: mobjects/image/index.ts:546

Get the current filter options

Returns​

ImageFilterOptions

getHeight()​

getHeight(): number

Defined in: mobjects/image/index.ts:502

Get the display height

Returns​

number

getLeft()​

getLeft(): Vector3Tuple

Defined in: core/Mobject.ts:379

Returns​

Vector3Tuple

Inherited from​

Mobject.getLeft

getNaturalSize()​

getNaturalSize(): object

Defined in: mobjects/image/index.ts:610

Get the natural (original) dimensions of the image

Returns​

object

height​

height: number

width​

width: number

getRight()​

getRight(): Vector3Tuple

Defined in: core/Mobject.ts:382

Returns​

Vector3Tuple

Inherited from​

Mobject.getRight

getSource()​

getSource(): string

Defined in: mobjects/image/index.ts:464

Get the image source

Returns​

string

getThreeObject()​

getThreeObject(): Object3D

Defined in: core/Mobject.ts:452

Returns​

Object3D

Inherited from​

Mobject.getThreeObject

getTop()​

getTop(): Vector3Tuple

Defined in: core/Mobject.ts:373

Returns​

Vector3Tuple

Inherited from​

Mobject.getTop

getUpdaters()​

getUpdaters(): UpdaterFunction[]

Defined in: core/Mobject.ts:493

Returns​

UpdaterFunction[]

Inherited from​

Mobject.getUpdaters

getWidth()​

getWidth(): number

Defined in: mobjects/image/index.ts:485

Get the display width

Returns​

number

hasUpdaters()​

hasUpdaters(): boolean

Defined in: core/Mobject.ts:490

Returns​

boolean

Inherited from​

Mobject.hasUpdaters

isDoubleSided()​

isDoubleSided(): boolean

Defined in: mobjects/image/index.ts:594

Get whether double-sided rendering is enabled

Returns​

boolean

isLoaded()​

isLoaded(): boolean

Defined in: mobjects/image/index.ts:261

Check if the image has been loaded

Returns​

boolean

moveTo()​

moveTo(target, alignedEdge?): this

Defined in: core/Mobject.ts:192

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

Mobject.moveTo

moveToAligned()​

moveToAligned(target, alignedEdge?): this

Defined in: core/Mobject.ts:355

Parameters​

target​

Mobject | Vector3Tuple

alignedEdge?​

Vector3Tuple

Returns​

this

Inherited from​

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

Mobject.nextTo

prepareForNonlinearTransform()​

prepareForNonlinearTransform(numPieces): this

Defined in: core/Mobject.ts:509

Parameters​

numPieces​

number = 50

Returns​

this

Inherited from​

Mobject.prepareForNonlinearTransform

remove()​

remove(...mobjects): this

Defined in: core/Mobject.ts:260

Parameters​

mobjects​

...Mobject[]

Returns​

this

Inherited from​

Mobject.remove

removeUpdater()​

removeUpdater(updater): this

Defined in: core/Mobject.ts:480

Parameters​

updater​

UpdaterFunction

Returns​

this

Inherited from​

Mobject.removeUpdater

replace()​

replace(target, stretch): this

Defined in: core/Mobject.ts:299

Parameters​

target​

Mobject

stretch​

boolean = false

Returns​

this

Inherited from​

Mobject.replace

restoreState()​

restoreState(): boolean

Defined in: core/Mobject.ts:526

Returns​

boolean

Inherited from​

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

Mobject.rotate

rotateAboutOrigin()​

rotateAboutOrigin(angle, axis): this

Defined in: core/Mobject.ts:221

Parameters​

angle​

number

axis​

Vector3Tuple = ...

Returns​

this

Inherited from​

Mobject.rotateAboutOrigin

saveState()​

saveState(): this

Defined in: core/Mobject.ts:521

Returns​

this

Inherited from​

Mobject.saveState

scale()​

scale(factor): this

Defined in: core/Mobject.ts:233

Parameters​

factor​

number | Vector3Tuple

Returns​

this

Inherited from​

Mobject.scale

scaleToFitBox()​

scaleToFitBox(maxWidth, maxHeight): this

Defined in: mobjects/image/index.ts:535

Scale the image to fit within a bounding box

Parameters​

maxWidth​

number

Maximum width

maxHeight​

number

Maximum height

Returns​

this

setBrightness()​

setBrightness(value): this

Defined in: mobjects/image/index.ts:580

Set brightness

Parameters​

value​

number

Returns​

this

setColor()​

setColor(color): this

Defined in: core/Mobject.ts:127

Parameters​

color​

string

Returns​

this

Inherited from​

Mobject.setColor

setContrast()​

setContrast(value): this

Defined in: mobjects/image/index.ts:587

Set contrast

Parameters​

value​

number

Returns​

this

setDoubleSided()​

setDoubleSided(value): this

Defined in: mobjects/image/index.ts:601

Set double-sided rendering

Parameters​

value​

boolean

Returns​

this

setFill()​

setFill(color?, opacity?): this

Defined in: core/Mobject.ts:165

Parameters​

color?​

string

opacity?​

number

Returns​

this

Inherited from​

Mobject.setFill

setFillOpacity()​

setFillOpacity(opacity): this

Defined in: core/Mobject.ts:155

Parameters​

opacity​

number

Returns​

this

Inherited from​

Mobject.setFillOpacity

setFilters()​

setFilters(filters): this

Defined in: mobjects/image/index.ts:553

Set filter options

Parameters​

filters​

Partial<ImageFilterOptions>

Returns​

this

setGrayscale()​

setGrayscale(enabled): this

Defined in: mobjects/image/index.ts:566

Set grayscale filter

Parameters​

enabled​

boolean

Returns​

this

setHeight()​

setHeight(height): this

Defined in: mobjects/image/index.ts:509

Set the display height (width will be calculated from aspect ratio)

Parameters​

height​

number

Returns​

this

setInvert()​

setInvert(enabled): this

Defined in: mobjects/image/index.ts:573

Set invert filter

Parameters​

enabled​

boolean

Returns​

this

setOpacity()​

setOpacity(opacity): this

Defined in: core/Mobject.ts:135

Parameters​

opacity​

number

Returns​

this

Inherited from​

Mobject.setOpacity

setSize()​

setSize(width, height, scaleToFit): this

Defined in: mobjects/image/index.ts:522

Set both width and height

Parameters​

width​

number

Display width

height​

number

Display height

scaleToFit​

boolean = true

If true, scale to fit preserving aspect ratio

Returns​

this

setSource()​

setSource(source): this

Defined in: mobjects/image/index.ts:471

Set a new image source

Parameters​

source​

string

Returns​

this

setStrokeWidth()​

setStrokeWidth(width): this

Defined in: core/Mobject.ts:145

Parameters​

width​

number

Returns​

this

Inherited from​

Mobject.setStrokeWidth

setStyle()​

setStyle(style): this

Defined in: core/Mobject.ts:113

Parameters​

style​

Partial<MobjectStyle>

Returns​

this

Inherited from​

Mobject.setStyle

setWidth()​

setWidth(width): this

Defined in: mobjects/image/index.ts:492

Set the display width (height will be calculated from aspect ratio)

Parameters​

width​

number

Returns​

this

setX()​

setX(x): this

Defined in: core/Mobject.ts:385

Parameters​

x​

number

Returns​

this

Inherited from​

Mobject.setX

setY()​

setY(y): this

Defined in: core/Mobject.ts:389

Parameters​

y​

number

Returns​

this

Inherited from​

Mobject.setY

setZ()​

setZ(z): this

Defined in: core/Mobject.ts:393

Parameters​

z​

number

Returns​

this

Inherited from​

Mobject.setZ

shift()​

shift(delta): this

Defined in: core/Mobject.ts:184

Parameters​

delta​

Vector3Tuple

Returns​

this

Inherited from​

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

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

Mobject.toEdge

update()​

update(dt): void

Defined in: core/Mobject.ts:497

Parameters​

dt​

number

Returns​

void

Inherited from​

Mobject.update

waitForLoad()​

waitForLoad(): Promise<void>

Defined in: mobjects/image/index.ts:254

Wait for the image to be loaded

Returns​

Promise<void>

Promise that resolves when the image is loaded