Class SceneSpriteController

Hierarchy (View Summary)

SceneObjectController<SceneSprite>
- SceneSpriteController

Constructors

constructor

new SceneSpriteController(viewer: Viewer): SceneSpriteController
Parameters
- viewer: Viewer
Returns SceneSpriteController
Overrides SceneObjectController.constructor
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:10

Properties

`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 src/viewer/core/objects/SceneObjectController.ts:45

firstObject

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

uuids

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

Returns MapIterator<string>
Inherited from SceneObjectController.uuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:115

visible

get visible(): boolean
Returns boolean
Inherited from SceneObjectController.visible
- Defined in src/viewer/core/objects/SceneObjectController.ts:38
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 src/viewer/core/objects/SceneObjectController.ts:29

Methods

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 src/viewer/core/objects/sprites/SceneSpriteController.ts:24

addObject

addObject(object: SceneSprite, parentUuid: null | string): void
Adds the given object to the controller. Controllers may not support object hierarchy.
Parameters
- object: SceneSprite
  The object to add.
- parentUuid: null | string
  The parent uuid of the object if the controller supports it.
Returns void
Overrides SceneObjectController.addObject
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:32

cleanScene

cleanScene(scene: ViewerScene): void
Callback to clean the controller from the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.cleanScene
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:20

clear

clear(): void
Clears all objects from the controller

Returns void
Overrides SceneObjectController.clear
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:51

createSprite

createSprite(params?: SceneSpriteParams): SceneSprite
Parameters
- params: SceneSpriteParams = {}
Returns SceneSprite
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:44

dispose

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

Returns void
Inherited from SceneObjectController.dispose
- Defined in src/viewer/core/objects/SceneObjectController.ts:211

getAllHiddenObjects

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

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllHiddenObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:179

getAllHiddenObjectUuids

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

Returns Generator<string>
Inherited from SceneObjectController.getAllHiddenObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:201

getAllObjects

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

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:153

getAllObjectUuids

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

Returns Generator<string>
Inherited from SceneObjectController.getAllObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:160

getAllVisibleObjects

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

Returns Generator<SceneSprite>
Inherited from SceneObjectController.getAllVisibleObjects
- Defined in src/viewer/core/objects/SceneObjectController.ts:167

getAllVisibleObjectUuids

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

Returns Generator<string>
Inherited from SceneObjectController.getAllVisibleObjectUuids
- Defined in src/viewer/core/objects/SceneObjectController.ts:191

getFirstObject

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

getObjectByUUID

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

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 src/viewer/core/objects/SceneObjectController.ts:141

hasObjectUUID

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

removeObject

removeObject(object: SceneSprite): void
Removes the given object from the controller.
Parameters
- object: SceneSprite
Returns void
Overrides SceneObjectController.removeObject
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:38

setupScene

setupScene(scene: ViewerScene): void
Callback to setup the controller into the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.setupScene
- Defined in src/viewer/core/objects/sprites/SceneSpriteController.ts:16

Class SceneSpriteController

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneSpriteController

Properties

ReadonlyisSceneObjectController

Readonlysignals

Accessors

count

Returns number

firstObject

Returns null | TObject

uuids

Returns MapIterator<string>

visible

Returns boolean

Parameters

Returns void

Methods

accepts

Parameters

Returns boolean

addObject

Parameters

Returns void

cleanScene

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 null | SceneSprite

getObjectByUUID

Parameters

Returns null | SceneSprite

getObjectsByUUID

Parameters

Returns Generator<SceneSprite>

hasObjectUUID

Parameters

Returns boolean

removeObject

Parameters

Returns void

setupScene

Parameters

Returns void

Settings

On This Page

`Readonly`isSceneObjectController

`Readonly`signals