Skip to main content

SynchronizerManager

Index

Functions

Functions

createSynchronizer

  • createSynchronizer(synchronizerId: string, eventName: string, eventHandler: default): Synchronizer

  • Create a new synchronizer instance from Synchronizer class

    Parameters

    • synchronizerId: string

      The id of the synchronizer.

    • eventName: string

      The name of the event that will be emitted by the synchronizer.

    • eventHandler: default

      The event handler that will be called when the event is emitted.

    Returns Synchronizer

    A reference to the synchronizer.

destroy

  • destroy(): void

  • “Destroy all synchronizers.”

    Returns void

destroySynchronizer

  • destroySynchronizer(synchronizerId: string): void

  • Destroy a synchronizer by its ID.

    Parameters

    • synchronizerId: string

      The id of the synchronizer to destroy.

    Returns void

getAllSynchronizers

  • Return the array of synchronizers

    Returns Synchronizer[]

    An array of synchronizers.

getSynchronizer

  • getSynchronizer(synchronizerId: string): Synchronizer | void

  • Get the synchronizer with the given id from the state.

    Parameters

    • synchronizerId: string

      The id of the synchronizer to be retrieved.

    Returns Synchronizer | void

    A synchronizer object.

getSynchronizersForViewport

  • getSynchronizersForViewport(viewportId: string, renderingEngineId: string): Synchronizer[]

  • It returns all synchronizers that are not disabled and have a source viewport with the given rendering engine Id and viewport Id

    Parameters

    • viewportId: string

      The Id of the viewport

    • renderingEngineId: string

      The Id of the rendering engine

    Returns Synchronizer[]

    An array of synchronizers