Class SceneObjectController<TObject>Abstract

constructor

• new SceneObjectController<TObject extends SceneObject = SceneObject>(
      viewer: Viewer,
  ): SceneObjectController<TObject>

  Type Parameters

  • TObject extends SceneObject = SceneObject

  Parameters

  • viewer: Viewer

  Returns SceneObjectController<TObject>

ReadonlyisSceneObjectController

Readonlysignals

count

• get count(): number

  Controller objects count

  Returns number

firstObject

• get firstObject(): null | TObject

  Returns null | TObject

uuids

• get uuids(): MapIterator<string>

  Iterator over all the uuids contained in the controller.

  Returns MapIterator<string>

visible

• get visible(): boolean

  Returns boolean

• 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

Abstractaccepts

• accepts(object: SceneObject): boolean

  Indicates whether the controller accepts the SceneObject as a potential child.

  Parameters

  • object: SceneObject

  Returns boolean

addObject

• addObject(object: TObject, parentUuid: null | string): void

  Adds the given object to the controller. Controllers may not support object hierarchy.

  Parameters

  • object: TObject

    The object to add.
  • parentUuid: null | string

    The parent uuid of the object if the controller supports it.

  Returns void

AbstractcleanScene

• cleanScene(scene: ViewerScene): void

  Callback to clean the controller from the scene

  Parameters

  • scene: ViewerScene

  Returns void

clear

• clear(): void

  Clears all objects from the controller

  Returns void

dispose

• dispose(): void

  Disposes the controller and destroy its data

  Returns void

getAllHiddenObjects

• getAllHiddenObjects(): Generator<TObject>

  Returns a generator of hidden objects of this controller

  Returns Generator<TObject>

getAllHiddenObjectUuids

• getAllHiddenObjectUuids(): Generator<string>

  Returns a generator of hidden object uuids of this controller

  Returns Generator<string>

getAllObjects

• getAllObjects(): Generator<TObject>

  Returns a generator of objects of this controller

  Returns Generator<TObject>

getAllObjectUuids

• getAllObjectUuids(): Generator<string>

  Returns a generator of object uuids of this controller

  Returns Generator<string>

getAllVisibleObjects

• getAllVisibleObjects(): Generator<TObject>

  Returns a generator of visible objects of this controller

  Returns Generator<TObject>

getAllVisibleObjectUuids

• getAllVisibleObjectUuids(): Generator<string>

  Returns a generator if visible object uuids of this controller

  Returns Generator<string>

getFirstObject

• getFirstObject(): null | TObject

  Returns null | TObject

getObjectByUUID

• getObjectByUUID(uuid: string): null | TObject

  Returns the object associated with the given uuid if found

  Parameters

  • uuid: string

  Returns null | TObject

getObjectsByUUID

• getObjectsByUUID(uuids: Iterable<string>): Generator<TObject>

  Returns a generator of objects with the given uuids

  Parameters

  • uuids: Iterable<string>

  Returns Generator<TObject>

hasObjectUUID

• hasObjectUUID(uuid: string): boolean

  Returns whether the controller has the given uuid

  Parameters

  • uuid: string

  Returns boolean

removeObject

• removeObject(object: TObject): void

  Removes the given object from the controller.

  Parameters

  • object: TObject

  Returns void

AbstractsetupScene

• setupScene(scene: ViewerScene): void

  Callback to setup the controller into the scene

  Parameters

  • scene: ViewerScene

  Returns void