@stereograph/teiaviewer - v18.5.0-dev
    Preparing search index...

    Class SpriteController

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    instances isSceneObjectController signals

    Accessors

    count firstObject uuids visible

    Methods

    accepts addObject clear createSprite dispose getAllHiddenObjects getAllHiddenObjectUuids getAllObjects getAllObjectUuids getAllVisibleObjects getAllVisibleObjectUuids getFirstObject getObjectByUUID getObjectsByUUID hasObjectUUID onSceneClear onSceneSetup removeObject

    Constructors

    Properties

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

    Accessors

    • get count(): number

      Controller objects count

      Returns number

    • get firstObject(): null | TObject

      Returns null | TObject

    • get uuids(): MapIterator<string>

      Iterator over all the uuids contained in the controller.

      Returns MapIterator<string>

    • 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

    Methods

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

      Parameters

      Returns boolean

    • Add sprite to the box tree and to the controller

      Parameters

      Returns void

    • Clears all objects from the controller

      Returns void

    • Create a new sprite

      Parameters

      • position: Vector3
      • scale: Vector2
      • OptionalclickCallback: () => void
      • depthTest: boolean = true

      Returns SceneSprite

    • Disposes the controller and destroy its data

      Returns void

    • Returns a generator of hidden object uuids of this controller

      Returns Generator<string>

    • Returns a generator of object uuids of this controller

      Returns Generator<string>

    • Returns a generator if visible object uuids of this controller

      Returns Generator<string>

    • Returns a generator of objects with the given uuids

      Parameters

      • uuids: Iterable<string>

      Returns Generator<SceneSprite>

    • Returns whether the controller has the given uuid

      Parameters

      • uuid: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods