Class SpriteController

Controller owning every SceneSprite in the scene. Sprites are packed into SpriteContainer instances (one texture atlas each); a new sprite reuses a container with a free slot matching its depth-test mode, or creates one.

Hierarchy (View Summary)

SceneObjectController<SceneSprite>
- SpriteController

Constructors

constructor

new SpriteController(viewer: Viewer): SpriteController
Parameters
- viewer: Viewer
Returns SpriteController
Overrides SceneObjectController.constructor
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:24

Properties

`Protected` `Readonly`_objects

_objects: Map<string, SceneSprite> = ...

`Protected` `Readonly`_viewer

_viewer: Viewer

`Readonly`instances

instances: SpriteContainer[] = ...

`Readonly`isSceneObjectController

isSceneObjectController: true

`Readonly`signals

signals: {
    onObjectAdded: ViewerSignal<(object: SceneSprite) => void>;
    onObjectRemoved: ViewerSignal<(object: SceneSprite) => void>;
    onObjectUpdated: ViewerSignal<(object: SceneSprite) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

Accessors

count

get count(): number
Controller objects count

Returns number
Inherited from SceneObjectController.count
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:68

firstObject

get firstObject(): TObject | null
Returns TObject | null
Inherited from SceneObjectController.firstObject
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:95

uuids

get uuids(): MapIterator<string>
Iterator over all the uuids contained in the controller.

Returns MapIterator<string>
Inherited from SceneObjectController.uuids
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:140

visible

get visible(): boolean
Returns boolean
Inherited from SceneObjectController.visible
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:61
set visible(value: boolean): void
Controller visibility (independant from object own visibility).

Hiding a controller will hide all its children without modifying their own visibility.
Parameters
- value: boolean
Returns void
Inherited from SceneObjectController.visible
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:52

Methods

`Protected`_createSignals

_createSignals(): {
    onObjectAdded: ViewerSignal<(object: SceneSprite) => void>;
    onObjectRemoved: ViewerSignal<(object: SceneSprite) => void>;
    onObjectUpdated: ViewerSignal<(object: SceneSprite) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
}
Returns {
    onObjectAdded: ViewerSignal<(object: SceneSprite) => void>;
    onObjectRemoved: ViewerSignal<(object: SceneSprite) => void>;
    onObjectUpdated: ViewerSignal<(object: SceneSprite) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
}
Inherited from SceneObjectController._createSignals
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:38

`Protected`_setVisibility

_setVisibility(value: boolean): void
To be implemented by controllers to set global visibility (at controller level)
Parameters
- value: boolean
Returns void
Overrides SceneObjectController._setVisibility
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:44

accepts

accepts(object: SceneObject): boolean
Indicates whether the controller accepts the SceneObject as a potential child.
Parameters
- object: SceneObject
Returns boolean
Overrides SceneObjectController.accepts
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:40

addObject

addObject(object: SceneSprite, parentUuid: string | null): void
Add sprite to the box tree and to the controller
Parameters
- object: SceneSprite
- parentUuid: string | null
Returns void
Overrides SceneObjectController.addObject
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:81

clear

clear(): void
Clears all objects from the controller

Returns void
Overrides SceneObjectController.clear
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:115

createSprite

createSprite(
    position: Vector3,
    scale: Vector2,
    clickCallback?: () => void,
    depthTest?: boolean,
): SceneSprite
Create a new sprite
Parameters
- position: Vector3
- scale: Vector2
- OptionalclickCallback: () => void
- depthTest: boolean = true
Returns SceneSprite
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:104

dispose

dispose(): void
Disposes the controller and destroy its data

Returns void
Overrides SceneObjectController.dispose
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:124

getAllHiddenObjects

getAllHiddenObjects(): Generator<SceneSprite>
Returns a generator of hidden objects of this controller

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllHiddenObjects
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:204

getAllHiddenObjectUuids

getAllHiddenObjectUuids(): Generator<string>
Returns a generator of hidden object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllHiddenObjectUuids
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:226

getAllObjects

getAllObjects(): Generator<SceneSprite>
Returns a generator of objects of this controller

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllObjects
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:178

getAllObjectUuids

getAllObjectUuids(): Generator<string>
Returns a generator of object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllObjectUuids
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:185

getAllVisibleObjects

getAllVisibleObjects(): Generator<SceneSprite>
Returns a generator of visible objects of this controller

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllVisibleObjects
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:192

getAllVisibleObjectUuids

getAllVisibleObjectUuids(): Generator<string>
Returns a generator if visible object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllVisibleObjectUuids
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:216

getFirstObject

getFirstObject(): SceneSprite | null
Returns SceneSprite | null
Inherited from SceneObjectController.getFirstObject
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:128

getObjectByUUID

getObjectByUUID(uuid: string): SceneSprite | null
Returns the object associated with the given uuid if found
Parameters
- uuid: string
Returns SceneSprite | null
Inherited from SceneObjectController.getObjectByUUID
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:158

getObjectsByUUID

getObjectsByUUID(uuids: Iterable<string>): Generator<SceneSprite>
Returns a generator of objects with the given uuids
Parameters
- uuids: Iterable<string>
Returns Generator<SceneSprite>
Inherited from SceneObjectController.getObjectsByUUID
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:166

hasObjectUUID

hasObjectUUID(uuid: string): boolean
Returns whether the controller has the given uuid
Parameters
- uuid: string
Returns boolean
Inherited from SceneObjectController.hasObjectUUID
- Defined in packages/viewer/src/scene/objects/SceneObjectController.ts:149

onSceneClear

onSceneClear(scene: ViewerScene): void
Callback to clean the controller from the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.onSceneClear
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:34

onSceneSetup

onSceneSetup(scene: ViewerScene): void
Callback to setup the controller into the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.onSceneSetup
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:28

removeObject

removeObject(object: SceneSprite): void
Delete a sprite and remove it from the scene
Parameters
- object: SceneSprite
Returns void
Overrides SceneObjectController.removeObject
- Defined in packages/viewer/src/scene/objects/sprites/SpriteController.ts:90

Class SpriteController

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SpriteController

Properties

Protected Readonly_objects

Protected Readonly_viewer

Readonlyinstances

ReadonlyisSceneObjectController

Readonlysignals

Accessors

count

Returns number

firstObject

Returns TObject | null

uuids

Returns MapIterator<string>

visible

Returns boolean

Parameters

Returns void

Methods

Protected_createSignals

Returns { onObjectAdded: ViewerSignal<(object: SceneSprite) => void>; onObjectRemoved: ViewerSignal<(object: SceneSprite) => void>; onObjectUpdated: ViewerSignal<(object: SceneSprite) => void>; onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;}

Protected_setVisibility

Parameters

Returns void

accepts

Parameters

Returns boolean

addObject

Parameters

Returns void

clear

Returns void

createSprite

Parameters

Returns SceneSprite

dispose

Returns void

getAllHiddenObjects

Returns Generator<SceneSprite>

getAllHiddenObjectUuids

Returns Generator<string>

getAllObjects

Returns Generator<SceneSprite>

getAllObjectUuids

Returns Generator<string>

getAllVisibleObjects

Returns Generator<SceneSprite>

getAllVisibleObjectUuids

Returns Generator<string>

getFirstObject

Returns SceneSprite | null

getObjectByUUID

Parameters

Returns SceneSprite | null

getObjectsByUUID

Parameters

Returns Generator<SceneSprite>

hasObjectUUID

Parameters

Returns boolean

onSceneClear

Parameters

Returns void

onSceneSetup

Parameters

Returns void

removeObject

Parameters

Returns void

Settings

`Protected` `Readonly`_objects

`Protected` `Readonly`_viewer

`Readonly`instances

`Readonly`isSceneObjectController

`Readonly`signals

`Protected`_createSignals

Returns {
onObjectAdded: ViewerSignal<(object: SceneSprite) => void>;
onObjectRemoved: ViewerSignal<(object: SceneSprite) => void>;
onObjectUpdated: ViewerSignal<(object: SceneSprite) => void>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
}

`Protected`_setVisibility