Class SceneSprite

A 2D marker rendered from a shared SpriteContainer slot (the sprite counterpart of SceneMeshProxy for meshes): it holds no geometry of its own — position, scale and visibility all forward to its proxy slot in the container.

Hierarchy (View Summary)

RaycastableSceneObject
- SceneSprite

Constructors

constructor

new SceneSprite(
    container: SpriteContainer,
    proxyId: number,
    clickCallback?: () => void,
    uuid?: string,
): SceneSprite
Parameters
- container: SpriteContainer
- proxyId: number
- OptionalclickCallback: () => void
- uuid: string = ...
Returns SceneSprite
Overrides RaycastableSceneObject.constructor
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:33

Properties

`Readonly`children

children: SceneObject[] = ...

`Optional` `Readonly`clickCallback

clickCallback?: () => void

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = true

`Readonly`isSceneObject

isSceneObject: true

`Readonly`isSceneSprite

isSceneSprite: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

isTransformable

isTransformable: boolean = true

name

name: string = ''

parent

parent: SceneObject | null = null

`Readonly`signals

signals: {
onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

Accessors

isAlwaysVisible

get isAlwaysVisible(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:45

selected

get selected(): boolean
Returns boolean
Overrides RaycastableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:130
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides RaycastableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:126

type

get type(): string
Returns string
Inherited from RaycastableSceneObject.type
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:102

visible

get visible(): boolean
Returns boolean
Overrides RaycastableSceneObject.visible
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:109
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides RaycastableSceneObject.visible
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:104

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Overrides RaycastableSceneObject.addChild
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:99

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from RaycastableSceneObject.applyMatrix
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:122

delete

delete(): void
Returns void
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:95

dispose

dispose(): void
Returns void
Inherited from RaycastableSceneObject.dispose
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:212

getBoundingBox

getBoundingBox(target: Box3): Box3
Parameters
- target: Box3
Returns Box3
Overrides RaycastableSceneObject.getBoundingBox
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:147

getBoundingSphere

getBoundingSphere(target: Sphere): Sphere
Parameters
- target: Sphere
Returns Sphere
Overrides RaycastableSceneObject.getBoundingSphere
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:151

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Overrides RaycastableSceneObject.getMatrix
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:56

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Overrides RaycastableSceneObject.getPosition
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:65

getScale

getScale(target: Vector2): Vector2
Parameters
- target: Vector2
Returns Vector2
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:73

getStateController

getStateController(): ObjectStateController<SceneSprite, ObjectState>
Returns ObjectStateController<SceneSprite, ObjectState>
Inherited from RaycastableSceneObject.getStateController
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:155

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from RaycastableSceneObject.parentsGenerator
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:140

projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance: number,
): boolean
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number
Returns boolean
Overrides RaycastableSceneObject.projectPointOnEdges
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:158

raycast

raycast(raycaster: Raycaster, intersections: SceneIntersection[]): void
Performs raycasting on the mesh.
Parameters
- raycaster: Raycaster
  The raycaster to use
- intersections: SceneIntersection[]
  The array of resulting intersections
Returns void
Overrides RaycastableSceneObject.raycast
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:134

removeFromParent

removeFromParent(): void
Returns void
Inherited from RaycastableSceneObject.removeFromParent
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:148

setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Overrides RaycastableSceneObject.setMatrix
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:49

setPosition

setPosition(pos: Vector3): Vector3
Parameters
- pos: Vector3
Returns Vector3
Overrides RaycastableSceneObject.setPosition
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:69

setScale

setScale(pos: Vector2): Vector2
Parameters
- pos: Vector2
Returns Vector2
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:77

setTexture

setTexture(textureOption: TextureOption): Promise<void>
Parameters
- textureOption: TextureOption
Returns Promise<void>
- Defined in packages/viewer/src/scene/objects/sprites/SceneSprite.ts:89

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from RaycastableSceneObject.toJson
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:195

Class SceneSprite

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneSprite

Properties

Readonlychildren

Optional ReadonlyclickCallback

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneObject

ReadonlyisSceneSprite

isSelectable

isTransformable

name

parent

Readonlysignals

ReadonlytransformConfig

userData

Readonlyuuid

Accessors

isAlwaysVisible

Returns boolean

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

Methods

addChild

Parameters

Returns void

applyMatrix

Parameters

Returns void

delete

Returns void

dispose

Returns void

getBoundingBox

Parameters

Returns Box3

getBoundingSphere

Parameters

Returns Sphere

getMatrix

Parameters

Returns Matrix4

getPosition

Parameters

Returns Vector3

getScale

Parameters

Returns Vector2

getStateController

Returns ObjectStateController<SceneSprite, ObjectState>

parentsGenerator

Returns Generator<SceneObject, void, unknown>

projectPointOnEdges

Parameters

Returns boolean

raycast

Parameters

Returns void

removeFromParent

Returns void

setMatrix

Parameters

Returns void

`Readonly`children

`Optional` `Readonly`clickCallback

`Readonly`isDisplayable

`Readonly`isSceneObject

`Readonly`isSceneSprite

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid