Sprite2D

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:180

Extends

• Mesh 

Extended by

• AnimatedSprite2D

Constructors

Constructor

new Sprite2D(options?): Sprite2D

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:880

Create a new Sprite2D. Can be called with no arguments for R3F compatibility - set texture via property.

Parameters

options?

Sprite2DOptions

Returns

Sprite2D

Overrides

Mesh.constructor

Properties

_idx

_idx: number = 0

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:515

Index into the backing arrays (0 when standalone, eid when enrolled).

---

alphaMap

alphaMap: AlphaMap | null = null

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:253

CPU-side alpha data for 'alpha' hit-test mode.

---

alphaThreshold

alphaThreshold: number = 0.5

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:256

Alpha value (0–1) below which a pixel is treated as transparent.

---

animations

animations: AnimationClip []

Defined in: three.js/core/Object3D:animations 

Array with object’s animation clips.

Default Value

[]

Inherited from

Mesh.animations

---

castShadow

castShadow: boolean

Defined in: three.js/core/Object3D:castShadow 

Whether the object gets rendered into shadow map.

Default Value

false

Inherited from

Mesh.castShadow

---

children

children: Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:children 

Array with object’s children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

Inherited from

Mesh.children

---

count

count: number

Defined in: three.js/objects/Mesh:count 

The number of instances of this mesh. Can only be used with WebGPURenderer.

Default

1

Inherited from

Mesh.count

---

customDepthMaterial?

optional customDepthMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDepthMaterial 

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

Default Value

undefined

Inherited from

Mesh.customDepthMaterial

---

customDistanceMaterial?

optional customDistanceMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDistanceMaterial 

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

Inherited from

Mesh.customDistanceMaterial

---

frustumCulled

frustumCulled: boolean

Defined in: three.js/core/Object3D:frustumCulled 

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

Inherited from

Mesh.frustumCulled

---

geometry

geometry: BufferGeometry 

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:184

An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object’s structure.

Default Value

THREE.BufferGeometry | `new THREE.BufferGeometry()`.

Overrides

Mesh.geometry

---

id

readonly id: number

Defined in: three.js/core/Object3D:id 

Unique number for this Object3D  instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object. Expects a Integer

Inherited from

Mesh.id

---

isMesh

readonly isMesh: true

Defined in: three.js/objects/Mesh:isMesh 

Read-only flag to check if a given object is of type Mesh .

Remarks

This is a constant value

Default Value

true

Inherited from

Mesh.isMesh

---

isObject3D

readonly isObject3D: true

Defined in: three.js/core/Object3D:isObject3D 

Flag to check if a given object is of type Object3D .

Remarks

This is a constant value

Default Value

true

Inherited from

Mesh.isObject3D

---

layers

layers: Layers 

Defined in: three.js/core/Object3D:layers 

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

Inherited from

Mesh.layers

---

material

material: Sprite2DMaterial

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:185

An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object’s appearance.

Default Value

THREE.MeshBasicMaterial | `new THREE.MeshBasicMaterial()`.

Overrides

Mesh.material

---

matrix

matrix: Matrix4 

Defined in: three.js/core/Object3D:matrix 

The local transform matrix.

Default Value

new THREE.Matrix4()

Inherited from

Mesh.matrix

---

matrixAutoUpdate

matrixAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixAutoUpdate 

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

Inherited from

Mesh.matrixAutoUpdate

---

matrixWorld

matrixWorld: Matrix4 

Defined in: three.js/core/Object3D:matrixWorld 

The global transform of the object.

Remarks

If the Object3D  has no parent, then it’s identical to the local transform THREE.Object3D.matrix | .matrix.

Default Value

new THREE.Matrix4()

Inherited from

Mesh.matrixWorld

---

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldAutoUpdate 

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn’t, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

Inherited from

Mesh.matrixWorldAutoUpdate

---

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldNeedsUpdate 

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

Inherited from

Mesh.matrixWorldNeedsUpdate

---

modelViewMatrix

readonly modelViewMatrix: Matrix4 

Defined in: three.js/core/Object3D:modelViewMatrix 

Default Value

new THREE.Matrix4()

Inherited from

Mesh.modelViewMatrix

---

morphTargetDictionary?

optional morphTargetDictionary?: object

Defined in: three.js/objects/Mesh:morphTargetDictionary 

A dictionary of morphTargets based on the morphTarget.name property.

Index Signature

[key: string]: number

Default Value

undefined, but rebuilt by .updateMorphTargets() .

Inherited from

Mesh.morphTargetDictionary

---

morphTargetInfluences?

optional morphTargetInfluences?: number[]

Defined in: three.js/objects/Mesh:morphTargetInfluences 

An array of weights typically from 0-1 that specify how much of the morph is applied.

Default Value

undefined, but reset to a blank array by .updateMorphTargets() .

Inherited from

Mesh.morphTargetInfluences

---

name

name: string

Defined in: three.js/core/Object3D:name 

Optional name of the object

Remarks

(doesn’t need to be unique).

Default Value

""

Inherited from

Mesh.name

---

normalMatrix

readonly normalMatrix: Matrix3 

Defined in: three.js/core/Object3D:normalMatrix 

Default Value

new THREE.Matrix3()

Inherited from

Mesh.normalMatrix

---

occlusionTest?

optional occlusionTest?: boolean

Defined in: three.js/renderers/common/Backend:occlusionTest 

Inherited from

Mesh.occlusionTest

---

onBeforeRender

onBeforeRender: (renderer, scene, camera, geometry, material, group) => void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2230

Auto-orchestration Signal B: the sprite’s own mesh is being drawn, so the renderer and scene are in hand. One property check per draw once registered — the hot path stays ~free.

An optional callback that is executed immediately before a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Overrides

Mesh.onBeforeRender

---

parent

parent: Object3D <Object3DEventMap > | null

Defined in: three.js/core/Object3D:parent 

Object’s parent in the scene graph .

Remarks

An object can have at most one parent.

Default Value

null

Inherited from

Mesh.parent

---

pivot

pivot: Vector3  | null

Defined in: three.js/core/Object3D:pivot 

The pivot point for rotation and scale transformations. When set, rotation and scale are applied around this point instead of the object’s origin.

Default

null

Inherited from

Mesh.pivot

---

position

readonly position: Vector3 

Defined in: three.js/core/Object3D:position 

Object’s local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

Inherited from

Mesh.position

---

quaternion

readonly quaternion: Quaternion 

Defined in: three.js/core/Object3D:quaternion 

Object’s local rotation as a THREE.Quaternion | Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

Inherited from

Mesh.quaternion

---

receiveShadow

receiveShadow: boolean

Defined in: three.js/core/Object3D:receiveShadow 

Whether the material receives shadows.

Default Value

false

Inherited from

Mesh.receiveShadow

---

renderOrder

renderOrder: number

Defined in: three.js/core/Object3D:renderOrder 

This value allows the default rendering order of scene graph  objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group , all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.

Default Value

0

Inherited from

Mesh.renderOrder

---

rotation

readonly rotation: Euler 

Defined in: three.js/core/Object3D:rotation 

Object’s local rotation (Euler angles ), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

Inherited from

Mesh.rotation

---

scale

readonly scale: Vector3 

Defined in: three.js/core/Object3D:scale 

The object’s local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

Inherited from

Mesh.scale

---

static

static: boolean

Defined in: three.js/core/Object3D:static 

Whether the 3D object is supposed to be static or not. If set to true, it means the 3D object is not going to be changed after the initial renderer. This includes geometry and material settings. A static 3D object can be processed by the renderer slightly faster since certain state checks can be bypassed.

Only relevant in context of WebGPURenderer.

Default

false

Inherited from

Mesh.static

---

type

readonly type: string

Defined in: three.js/objects/Mesh:type 

Default Value

Mesh

Inherited from

Mesh.type

---

up

up: Vector3 

Defined in: three.js/core/Object3D:up 

This is used by the lookAt  method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

Inherited from

Mesh.up

---

userData

userData: Record<string, any>

Defined in: three.js/core/Object3D:userData 

An object that can be used to store custom data about the Object3D .

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

Inherited from

Mesh.userData

---

uuid

uuid: string

Defined in: three.js/core/Object3D:uuid 

UUID  of this object instance.

Remarks

This gets automatically assigned and shouldn’t be edited.

Inherited from

Mesh.uuid

---

visible

visible: boolean

Defined in: three.js/core/Object3D:visible 

Object gets rendered if true.

Default Value

true

Inherited from

Mesh.visible

---

DEFAULT_MATRIX_AUTO_UPDATE

static DEFAULT_MATRIX_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_AUTO_UPDATE 

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

Mesh.DEFAULT_MATRIX_AUTO_UPDATE

---

DEFAULT_MATRIX_WORLD_AUTO_UPDATE

static DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_WORLD_AUTO_UPDATE 

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

Mesh.DEFAULT_MATRIX_WORLD_AUTO_UPDATE

---

DEFAULT_UP

static DEFAULT_UP: Vector3 

Defined in: three.js/core/Object3D:DEFAULT_UP 

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Inherited from

Mesh.DEFAULT_UP

---

options

static options: RenderingSetting | undefined = undefined

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:182

Class-level rendering defaults, resolved before RenderingConfig.

---

supportedHitTestModes

readonly static supportedHitTestModes: readonly HitTestMode[]

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:250

Hit-test modes supported by this class. See spec §6.

Accessors

alpha

Get Signature

get alpha(): number

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1497

Get alpha/opacity.

Returns

number

Set Signature

set alpha(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1504

Set alpha/opacity (0-1).

Parameters

value

number

Returns

void

---

anchor

Get Signature

get anchor(): Vector2 

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1443

Get the anchor point. Returns the stored Vector2 (like Object3D.position).

Returns

Vector2 

Set Signature

set anchor(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1450

Set the anchor point. Accepts [x, y] array or Vector2.

Parameters

value

[number, number] | Vector2 

Returns

void

---

castsShadow

Get Signature

get castsShadow(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:447

Whether this sprite contributes its silhouette to the shadow-caster occlusion pre-pass. Stored as bit 2 of _systemFlags. Default: false — most sprites don’t cast; opt in by setting to true.

Consumed by the occlusion pre-pass shader, which masks the sprite’s alpha by this bit before the SDF seed. Flipping it takes effect on the next frame with zero CPU rebuild (same model as receiveShadows).

Returns

boolean

Set Signature

set castsShadow(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:451

Parameters

value

boolean

Returns

void

---

flipX

Get Signature

get flipX(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1517

Get flipX state.

Returns

boolean

Set Signature

set flipX(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1524

Set flipX state.

Parameters

value

boolean

Returns

void

---

flipY

Get Signature

get flipY(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1539

Get flipY state.

Returns

boolean

Set Signature

set flipY(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1546

Set flipY state.

Parameters

value

boolean

Returns

void

---

frame

Get Signature

get frame(): SpriteFrame | null

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1365

Get the current frame.

Returns

SpriteFrame | null

Set Signature

set frame(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1372

Set the current frame (R3F prop compatibility).

Parameters

value

SpriteFrame | null

Returns

void

---

height

Get Signature

get height(): number

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1677

Get the height of the sprite in world units.

Returns

number

---

hitRadius

Get Signature

get hitRadius(): number

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:276

Hit radius override in local units. Default 0.5 (inscribed half-width of unit quad).

Returns

number

Set Signature

set hitRadius(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:280

Parameters

value

number

Returns

void

---

hitTestMode

Get Signature

get hitTestMode(): HitTestMode

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:292

Pointer hit-testing strategy. Setting 'none' nulls the instance raycast property.

Returns

HitTestMode

Set Signature

set hitTestMode(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:296

Parameters

value

HitTestMode

Returns

void

---

lit

Get Signature

get lit(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:342

Whether this sprite receives lighting from Flatland’s LightEffect. Stored as bit 0 of _systemFlags so lit/unlit sprites with the same texture share the same material and batch together. Default: true — set lit = false to opt out.

Returns

boolean

Set Signature

set lit(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:346

Parameters

value

boolean

Returns

void

---

pixelPerfect

Get Signature

get pixelPerfect(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:315

Whether this sprite’s final projected translation snaps to physical pixels.

Returns

boolean

Set Signature

set pixelPerfect(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:319

Parameters

value

boolean

Returns

void

---

receiveShadows

Get Signature

get receiveShadows(): boolean

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:369

Whether this sprite receives shadows from the SDF shadow pipeline. Stored as bit 1 of _systemFlags. Default: true — set receiveShadows = false to opt out.

Returns

boolean

Set Signature

set receiveShadows(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:373

Parameters

value

boolean

Returns

void

---

shadowRadius

Get Signature

get shadowRadius(): number | undefined

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:421

Per-sprite occluder radius (world units) consumed by shadow-casting LightEffects — e.g. DefaultLightEffect’s SDF sphere-tracer uses it as the self-silhouette escape distance so a tracer launched from inside the caster steps out cleanly.

Returns undefined while in auto-resolve mode (default), in which case transformSyncSystem writes max(|scale.x|, |scale.y|) into the per-instance attribute each frame — covering animation frames and runtime scale changes without manual updates. Assign a number to override (useful when the visible body is tighter than the quad’s bounds, or when an off-center anchor pushes the silhouette). Assign undefined to return to auto-resolve.

Returns

number | undefined

Set Signature

set shadowRadius(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:425

Parameters

value

number | undefined

Returns

void

---

sortLayer

Get Signature

get sortLayer(): SortLayerValue

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1579

Get the sortLayer (primary sort key). Returns the registered name when one was assigned; the numeric order otherwise.

Returns

SortLayerValue

Set Signature

set sortLayer(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1591

Set the sortLayer (primary sort key) — a registered name (typed via SortLayerRegistry augmentation) or a finite signed 32-bit numeric order. Routes the sprite to the batch matching its new run key on the next system pass.

Throws

When a numeric order is outside the signed 32-bit range.

Parameters

value

SortLayerValue

Returns

void

---

texture

Get Signature

get texture(): Texture <unknown, TextureEventMap > | null

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1174

Get the current texture.

Returns

Texture <unknown, TextureEventMap > | null

Set Signature

set texture(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1181

Set a new texture.

Parameters

value

Texture <unknown, TextureEventMap > | null

Returns

void

---

tint

Get Signature

get tint(): Color 

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1476

Get tint color. Returns a stored Color reference (like Material.color). Mutating the returned Color triggers ECS sync via onChange callback.

Returns

Color 

Set Signature

set tint(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1483

Set tint color. Accepts Color, hex string, hex number, or [r, g, b] array (0-1).

Parameters

value

string | number | [number, number, number] | Color 

Returns

void

---

width

Get Signature

get width(): number

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1670

Get the width of the sprite in world units.

Returns

number

---

zIndex

Get Signature

get zIndex(): number

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1634

Get z-index within layer (secondary sort key).

Returns

number

Set Signature

set zIndex(value): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1656

Set z-index within layer (secondary sort key).

Hot path. Every moving sprite in a y-sorted scene calls this every frame, so the cost has to stay near-zero per call.

The raw SoA write is unconditional — transformSyncSystem reads _zIndexArr directly and bakes the value into the instance matrix for the GPU depth test. That alone is enough for alphaTest+depthWrite materials (GPU resolves order via the baked-in Z, no CPU sort needed).

For non-gated materials, we flip the batch’s _sortDirty flag so batchSortSystem knows to re-sort this batch on its next pass. This replaced the prior Changed(SpriteZIndex) channel — the generic change tracker enumerated every flip every frame even when the gate trivially skipped the sort, costing ~7ms/frame in a 12k-sprite demo. The per-batch boolean costs one ref read + one write.

Parameters

value

number

Returns

void

Methods

_setupInstanceAttributes()

_setupInstanceAttributes(): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1738

Set up instance attributes on the geometry for single-sprite rendering. Uses one interleaved buffer (mirroring SpriteBatch) so batched and standalone paths share the same shader attribute shape. Also allocates buffers for custom attributes from the material’s schema (pure effect data — effectBuf0, effectBuf1, …).

Returns

void

---

add()

add(…object): this

Defined in: three.js/core/Object3D:add 

Adds another Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D  can have at most one parent.

See

• attach 
• THREE.Group | Group for info on manually grouping objects.

Inherited from

Mesh.add

---

addEffect()

addEffect(effect): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1839

Add an effect instance to this sprite. Auto-registers the effect type on the material if not already registered. Sets the enable bit and writes effect data to packed buffers.

Parameters

effect

MaterialEffect

Returns

this

Example

const dissolve = new DissolveEffect()
dissolve.progress = 0.5
sprite.addEffect(dissolve)

---

addEventListener()

addEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:addEventListener 

Adds a listener to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, Sprite2D>

The function that gets called when the event is fired.

Returns

void

Inherited from

Mesh.addEventListener

---

applyMatrix4()

applyMatrix4(matrix): void

Defined in: three.js/core/Object3D:applyMatrix4 

Applies the matrix transform to the object and updates the object’s position, rotation and scale.

Parameters

matrix

Matrix4 

Returns

void

Inherited from

Mesh.applyMatrix4

---

applyQuaternion()

applyQuaternion(quaternion): this

Defined in: three.js/core/Object3D:applyQuaternion 

Applies the rotation represented by the quaternion to the object.

Parameters

quaternion

Quaternion 

Returns

this

Inherited from

Mesh.applyQuaternion

---

attach()

attach(object): this

Defined in: three.js/core/Object3D:attach 

Adds a Object3D  as a child of this, while maintaining the object’s world transform.

Parameters

object

Object3D 

Returns

this

Remarks

Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See

add 

Inherited from

Mesh.attach

---

clear()

clear(): this

Defined in: three.js/core/Object3D:clear 

Removes all child objects.

Returns

this

Inherited from

Mesh.clear

---

clone()

clone(recursive?): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2817

Clone the sprite.

Parameters

recursive?

boolean

Returns

this

Overrides

Mesh.clone

---

copy()

copy(source, recursive?): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2804

Copy Three.js object state while preserving authored visibility. A batched source is internally suppressed, but that implementation detail must not make the copied sprite authored-hidden.

Parameters

source

this

recursive?

boolean

Returns

this

Overrides

Mesh.copy

---

dispatchEvent()

dispatchEvent<T>(event): void

Defined in: three.js/core/EventDispatcher:dispatchEvent 

Fire an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

event

BaseEvent <T> & Object3DEventMap [T]

The event that gets fired.

Returns

void

Inherited from

Mesh.dispatchEvent

---

dispose()

dispose(): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2741

Dispose of resources.

Returns

void

---

flip()

flip(horizontal, vertical): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1561

Flip the sprite.

Parameters

horizontal

boolean

vertical

boolean

Returns

this

---

getObjectById()

getObjectById(id): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectById 

Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

Parameters

id

number

Unique number of the object instance. Expects a Integer

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object.

See

id

Inherited from

Mesh.getObjectById

---

getObjectByName()

getObjectByName(name): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByName 

Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Parameters

name

string

String to match to the children’s Object3D.name property.

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

Inherited from

Mesh.getObjectByName

---

getObjectByProperty()

getObjectByProperty(name, value): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

the property name to search for.

value

any

value of the given property.

Returns

Object3D <Object3DEventMap > | undefined

Inherited from

Mesh.getObjectByProperty

---

getObjectsByProperty()

getObjectsByProperty(name, value, optionalTarget?): Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:getObjectsByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

The property name to search for.

value

any

Value of the given property.

optionalTarget?

Object3D <Object3DEventMap >[]

target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).

Returns

Object3D <Object3DEventMap >[]

Inherited from

Mesh.getObjectsByProperty

---

getVertexPosition()

getVertexPosition(index, target): Vector3 

Defined in: three.js/objects/Mesh:getVertexPosition 

Get the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.

Parameters

index

number

Expects a Integer

target

Vector3 

Returns

Vector3 

Inherited from

Mesh.getVertexPosition

---

getWorldDirection()

getWorldDirection(target): Vector3 

Defined in: three.js/core/Object3D:getWorldDirection 

Returns a vector representing the direction of object’s positive z-axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Mesh.getWorldDirection

---

getWorldPosition()

getWorldPosition(target): Vector3 

Defined in: three.js/core/Object3D:getWorldPosition 

Returns a vector representing the position of the object in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Mesh.getWorldPosition

---

getWorldPosition2D()

getWorldPosition2D(): Vector2 

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1817

Get world position (convenience method).

Returns

Vector2 

---

getWorldQuaternion()

getWorldQuaternion(target): Quaternion 

Defined in: three.js/core/Object3D:getWorldQuaternion 

Returns a quaternion representing the rotation of the object in world space.

Parameters

target

Quaternion 

The result will be copied into this Quaternion.

Returns

Quaternion 

Inherited from

Mesh.getWorldQuaternion

---

getWorldScale()

getWorldScale(target): Vector3 

Defined in: three.js/core/Object3D:getWorldScale 

Returns a vector of the scaling factors applied to the object for each axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

Mesh.getWorldScale

---

hasEventListener()

hasEventListener<T>(type, listener): boolean

Defined in: three.js/core/EventDispatcher:hasEventListener 

Checks if listener is added to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, Sprite2D>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

Mesh.hasEventListener

---

localToWorld()

localToWorld(vector): Vector3 

Defined in: three.js/core/Object3D:localToWorld 

Converts the vector from this object’s local space to world space.

Parameters

vector

Vector3 

A vector representing a position in this object’s local space.

Returns

Vector3 

Inherited from

Mesh.localToWorld

---

lookAt()

Call Signature

lookAt(vector): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

vector

Vector3 

A vector representing a position in world space to look at.

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

Mesh.lookAt

Call Signature

lookAt(x, y, z): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

x

number

Expects a Float

y

number

Expects a Float

z

number

Expects a Float

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

Mesh.lookAt

---

onAfterRender()

onAfterRender(renderer, scene, camera, geometry, material, group): void

Defined in: three.js/core/Object3D:onAfterRender 

An optional callback that is executed immediately after a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Mesh.onAfterRender

---

onAfterShadow()

onAfterShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onAfterShadow 

An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Mesh.onAfterShadow

---

onBeforeShadow()

onBeforeShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onBeforeShadow 

An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

Mesh.onBeforeShadow

---

raycast()

raycast(raycaster, intersects): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2242

Pointer raycast against the sprite’s local Z=0 plane.

The quad is a centered unit square ([-0.5, 0.5] in X and Y). Anchor and scale are already baked into the world matrix by updateMatrix(), so this method works entirely in centered-quad local space with no anchor math.

Parameters

raycaster

Raycaster 

intersects

Intersection <Object3D <Object3DEventMap >>[]

Returns

void

Overrides

Mesh.raycast

---

remove()

remove(…object): this

Defined in: three.js/core/Object3D:remove 

Removes a Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be removed.

See

THREE.Group | Group for info on manually grouping objects.

Inherited from

Mesh.remove

---

removeEffect()

removeEffect(effect): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1981

Remove an effect instance from this sprite. Clears the enable bit and resets effect data to defaults. The effect type remains registered on the material (no shader change).

Parameters

effect

MaterialEffect

Returns

this

---

removeEventListener()

removeEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:removeEventListener 

Removes a listener from an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener <Object3DEventMap [T], T, Sprite2D>

The listener function that gets removed.

Returns

void

Inherited from

Mesh.removeEventListener

---

removeFromParent()

removeFromParent(): this

Defined in: three.js/core/Object3D:removeFromParent 

Removes this object from its current parent.

Returns

this

Inherited from

Mesh.removeFromParent

---

rotateOnAxis()

rotateOnAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnAxis 

Rotate an object along an axis in object space.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

Mesh.rotateOnAxis

---

rotateOnWorldAxis()

rotateOnWorldAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnWorldAxis 

Rotate an object along an axis in world space.

Parameters

axis

Vector3 

A normalized vector in world space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized Method Assumes no rotated parent.

Inherited from

Mesh.rotateOnWorldAxis

---

rotateX()

rotateX(angle): this

Defined in: three.js/core/Object3D:rotateX 

Rotates the object around x axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Mesh.rotateX

---

rotateY()

rotateY(angle): this

Defined in: three.js/core/Object3D:rotateY 

Rotates the object around y axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Mesh.rotateY

---

rotateZ()

rotateZ(angle): this

Defined in: three.js/core/Object3D:rotateZ 

Rotates the object around z axis in local space.

Parameters

angle

number

Returns

this

Inherited from

Mesh.rotateZ

---

setAnchor()

setAnchor(x, y): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1467

Set the anchor point (0-1). (0, 0) = top-left, (0.5, 0.5) = center, (0.5, 1) = bottom-center

The anchor offset is baked into the matrix transform — no geometry rebuild. Writing _anchor.set(...) triggers the observable.vector2 callback which marks the matrix dirty; the next updateMatrix picks up the new value.

Parameters

x

number

y

number

Returns

this

---

setFrame()

setFrame(frame): this

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:1382

Set the current frame. Note: Does not modify scale - call updateSize() manually if needed after first frame.

Parameters

frame

SpriteFrame

Returns

this

---

setRotationFromAxisAngle()

setRotationFromAxisAngle(axis, angle): void

Defined in: three.js/core/Object3D:setRotationFromAxisAngle 

Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

Angle in radians. Expects a Float

Returns

void

Inherited from

Mesh.setRotationFromAxisAngle

---

setRotationFromEuler()

setRotationFromEuler(euler): void

Defined in: three.js/core/Object3D:setRotationFromEuler 

Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

Parameters

euler

Euler 

Euler angle specifying rotation amount.

Returns

void

Inherited from

Mesh.setRotationFromEuler

---

setRotationFromMatrix()

setRotationFromMatrix(m): void

Defined in: three.js/core/Object3D:setRotationFromMatrix 

Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

Parameters

m

Matrix4 

Rotate the quaternion by the rotation component of the matrix.

Returns

void

Remarks

Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

Inherited from

Mesh.setRotationFromMatrix

---

setRotationFromQuaternion()

setRotationFromQuaternion(q): void

Defined in: three.js/core/Object3D:setRotationFromQuaternion 

Copy the given THREE.Quaternion | Quaternion into .quaternion.

Parameters

q

Quaternion 

Normalized Quaternion.

Returns

void

Inherited from

Mesh.setRotationFromQuaternion

---

toJSON()

toJSON(meta?): MeshJSON 

Defined in: three.js/objects/Mesh:toJSON 

Convert the object to three.js JSON Object/Scene format .

Parameters

meta?

JSONMeta 

Object containing metadata such as materials, textures or images for the object.

Returns

MeshJSON 

Inherited from

Mesh.toJSON

---

translateOnAxis()

translateOnAxis(axis, distance): this

Defined in: three.js/core/Object3D:translateOnAxis 

Translate an object by distance along an axis in object space

Parameters

axis

Vector3 

A normalized vector in object space.

distance

number

The distance to translate. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

Mesh.translateOnAxis

---

translateX()

translateX(distance): this

Defined in: three.js/core/Object3D:translateX 

Translates object along x axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Mesh.translateX

---

translateY()

translateY(distance): this

Defined in: three.js/core/Object3D:translateY 

Translates object along y axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Mesh.translateY

---

translateZ()

translateZ(distance): this

Defined in: three.js/core/Object3D:translateZ 

Translates object along z axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

Mesh.translateZ

---

traverse()

traverse(callback): void

Defined in: three.js/core/Object3D:traverse 

Executes the callback on this object and all descendants.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Mesh.traverse

---

traverseAncestors()

traverseAncestors(callback): void

Defined in: three.js/core/Object3D:traverseAncestors 

Executes the callback on all ancestors.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Mesh.traverseAncestors

---

traverseVisible()

traverseVisible(callback): void

Defined in: three.js/core/Object3D:traverseVisible 

Like traverse, but the callback will only be executed for visible objects

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

Mesh.traverseVisible

---

updateMatrix()

updateMatrix(): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2460

Fast 2D matrix update — bypasses Three.js quaternion-based compose().

Three.js Object3D.updateMatrix() calls matrix.compose(position, quaternion, scale) which does full 3D quaternion→matrix math (~20 multiplies). For 2D sprites we only need position, scale, and optional Z-axis rotation — written directly to the matrix elements.

Also bakes in the layer/zIndex Z offset without save/restore of position.z.

Returns

void

Overrides

Mesh.updateMatrix

---

updateMatrixWorld()

updateMatrixWorld(force?): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2332

Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

Parameters

force?

boolean

A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

Returns

void

Overrides

Mesh.updateMatrixWorld

---

updateMorphTargets()

updateMorphTargets(): void

Defined in: three.js/objects/Mesh:updateMorphTargets 

Updates the morphTargets to have no influence on the object

Returns

void

Remarks

Resets the morphTargetInfluences and morphTargetDictionary  properties.

Inherited from

Mesh.updateMorphTargets

---

updateWorldMatrix()

updateWorldMatrix(updateParents, updateChildren): void

Defined in: packages/three-flatland/src/sprites/Sprite2D.ts:2324

Make matrixWorld current on demand. For an enrolled (batched) sprite, matrixWorldAutoUpdate is off and the sprite is not a graph child, so three’s own traversal never composes it — do it here. For a standalone sprite, defer to three’s normal ancestor walk. This is the standard three refresh contract, so any consumer (raycast, bounds, devtools) can sprite.updateWorldMatrix(true, false) then read matrixWorld.

Parameters

updateParents

boolean

updateChildren

boolean

Returns

void

Overrides

Mesh.updateWorldMatrix

---

worldToLocal()

worldToLocal(vector): Vector3 

Defined in: three.js/core/Object3D:worldToLocal 

Converts the vector from world space to this object’s local space.

Parameters

vector

Vector3 

A vector representing a position in world space.

Returns

Vector3 

Inherited from

Mesh.worldToLocal