Class SceneSpriteLegacy

Legacy raycastable wrapper around a plain three.js Sprite, kept for older code that builds sprites directly instead of going through a SpriteController.

Hierarchy (View Summary)

RaycastableSceneObject
- SceneSpriteLegacy
  - MeasureLineSprite

Constructors

constructor

new SceneSpriteLegacy(
sprite: Sprite,
params?: SceneSpriteLegacyParams,
): SceneSpriteLegacy
Parameters
- sprite: Sprite
- params: SceneSpriteLegacyParams = {}
Returns SceneSpriteLegacy
Overrides RaycastableSceneObject.constructor
- Defined in packages/viewer/src/scene/objects/sprites/SceneSpriteLegacy.ts:29

Properties

`Readonly`children

children: SceneObject[] = ...

`Optional` `Readonly`clickCallback

clickCallback?: () => void

`Readonly`isDisplayable

isDisplayable: true

isRaycastable

isRaycastable: boolean = true

`Readonly`isSceneObject

isSceneObject: true

`Readonly`isSceneSpriteLegacy

isSceneSpriteLegacy: 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`sprite

sprite: Sprite

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

Accessors

active

get active(): boolean
Returns boolean
Inherited from RaycastableSceneObject.active
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:180

material

get material(): SpriteMaterial
Returns SpriteMaterial
- Defined in packages/viewer/src/scene/objects/sprites/SceneSpriteLegacy.ts:40

selected

get selected(): boolean
Returns boolean
Inherited from RaycastableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:191
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from RaycastableSceneObject.selected
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:184

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/SceneSpriteLegacy.ts:106
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides RaycastableSceneObject.visible
- Defined in packages/viewer/src/scene/objects/sprites/SceneSpriteLegacy.ts:101

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from RaycastableSceneObject.addChild
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:128

applyMatrix

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

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/SceneSpriteLegacy.ts:63

getBoundingSphere

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

getMatrix

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

getPosition

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

getStateController

getStateController(): ObjectStateController<SceneSpriteLegacy, ObjectState>
Returns ObjectStateController<SceneSpriteLegacy, 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/SceneSpriteLegacy.ts:57

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/SceneSpriteLegacy.ts:44

removeFromParent

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

setMatrix

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

setPosition

setPosition(position: Vector3): Vector3
Parameters
- position: Vector3
Returns Vector3
Overrides RaycastableSceneObject.setPosition
- Defined in packages/viewer/src/scene/objects/sprites/SceneSpriteLegacy.ts:94

setTexture

setTexture(texture: Texture): void
Parameters
- texture: Texture
Returns void
- Defined in packages/viewer/src/scene/objects/sprites/SceneSpriteLegacy.ts:35

toJson

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

Class SceneSpriteLegacy

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneSpriteLegacy

Properties

Readonlychildren

Optional ReadonlyclickCallback

ReadonlyisDisplayable

isRaycastable

ReadonlyisSceneObject

ReadonlyisSceneSpriteLegacy

isSelectable

isTransformable

name

parent

Readonlysignals

Readonlysprite

ReadonlytransformConfig

userData

Readonlyuuid

Accessors

active

Returns boolean

material

Returns SpriteMaterial

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

Methods

addChild

Parameters

Returns void

applyMatrix

Parameters

Returns void

dispose

Returns void

getBoundingBox

Parameters

Returns Box3

getBoundingSphere

Parameters

Returns Sphere

getMatrix

Parameters

Returns Matrix4

getPosition

Parameters

Returns Vector3

getStateController

Returns ObjectStateController<SceneSpriteLegacy, ObjectState>

parentsGenerator

Returns Generator<SceneObject, void, unknown>

projectPointOnEdges

Parameters

Returns boolean

raycast

Parameters

Returns void

removeFromParent

Returns void

setMatrix

Parameters

Returns Matrix4

setPosition

Parameters

`Readonly`children

`Optional` `Readonly`clickCallback

`Readonly`isDisplayable

`Readonly`isSceneObject

`Readonly`isSceneSpriteLegacy

`Readonly`signals

`Readonly`sprite

`Readonly`transformConfig

`Readonly`uuid