Class EligiusEngine

This is where the magic happens. The engine is responsible for starting and stopping the given timeline provider and triggering the actions associated with the positions along the timeline.

Hierarchy

EligiusEngine

Implements

IEligiusEngine

Index

Constructors

constructor

Properties

_activeTimelineProvider _currentTimelineUri _eventbusRemovers _lastPosition _timeLineActionsLookup configuration eventbus languageManager timelineProviders

Constructors

constructor

new EligiusEngine(configuration, eventbus, timelineProviders, languageManager): EligiusEngine
Parameters
- configuration: IResolvedEngineConfiguration
- eventbus: IEventbus
- timelineProviders: Record<TimelineTypes, ITimelineProviderInfo>
- languageManager: LanguageManager
Returns EligiusEngine
- Defined in eligius-engine.ts:29

Properties

`Private` _activeTimelineProvider

_activeTimelineProvider: undefined | ITimelineProvider = undefined

`Private` _currentTimelineUri

_currentTimelineUri: string = ''

`Private` _eventbusRemovers

_eventbusRemovers: TEventbusRemover[] = []

`Private` _lastPosition

_lastPosition: number = -1

`Private` _timeLineActionsLookup

_timeLineActionsLookup: Record<string, Record<number, ActionMethod[]>> = {}

`Private` configuration

configuration: IResolvedEngineConfiguration

`Private` eventbus

eventbus: IEventbus

`Private` languageManager

languageManager: LanguageManager

`Private` timelineProviders

timelineProviders: Record<TimelineTypes, ITimelineProviderInfo>

Methods

`Private` _addEventListener

_addEventListener(eventName, eventHandler, eventTopic?): void
Parameters
- eventName: string
- eventHandler: TEventHandler
- Optional eventTopic: string
Returns void
- Defined in eligius-engine.ts:143

`Private` _addEventbusListeners

_addEventbusListeners(): void
Returns void
- Defined in eligius-engine.ts:147

`Private` _addTimelineActionEnd

_addTimelineActionEnd(uri, timeLineAction): void
Parameters
- uri: string
- timeLineAction: ITimelineAction
Returns void
- Defined in eligius-engine.ts:303

`Private` _addTimelineActionStart

_addTimelineActionStart(uri, timeLineAction): void
Parameters
- uri: string
- timeLineAction: ITimelineAction
Returns void
- Defined in eligius-engine.ts:287

`Private` _cleanUp

_cleanUp(): Promise<void>
Returns Promise<void>
- Defined in eligius-engine.ts:113

`Private` _cleanUpTimeline

_cleanUpTimeline(): Promise<void>
Returns Promise<void>
- Defined in eligius-engine.ts:402

`Private` _createLayoutTemplate

_createLayoutTemplate(): void
Returns void
- Defined in eligius-engine.ts:54

`Private` _createTimelineLookup

_createTimelineLookup(): void
Returns void
- Defined in eligius-engine.ts:248

`Private` _executeActions

_executeActions(actions, methodName, idx?): Promise<void>
Parameters
- actions: IEndableAction[]
- methodName: "start" | "end"
- idx: number = 0
Returns Promise<void>
- Defined in eligius-engine.ts:342

`Private` _executeActionsForPosition

_executeActionsForPosition(position): void
Parameters
- position: number
Returns void
- Defined in eligius-engine.ts:471

`Private` _executeRelevantActions

_executeRelevantActions(filter, executionType): Promise<void>
Parameters
- filter: ((actions) => ITimelineAction[])
  - - (actions): ITimelineAction[]
    - Parameters
      actions: ITimelineAction[]
      Returns ITimelineAction[]
- executionType: "start" | "end"
Returns Promise<void>
- Defined in eligius-engine.ts:428

`Private` _executeSeekActions

_executeSeekActions(position): Promise<void>
Parameters
- position: number
Returns Promise<void>
- Defined in eligius-engine.ts:481

`Private` _executeStartActions

_executeStartActions(): Promise<void>
Returns Promise<void>
- Defined in eligius-engine.ts:406

`Private` _getActionsForPosition

_getActionsForPosition(position, actions): ITimelineAction[]
Gets all of the inactive actions whose duration falls within the given timeline position.
Parameters
- position: number
  the given position
- actions: ITimelineAction[]
  all of the relevant actions
Returns ITimelineAction[]
- Defined in eligius-engine.ts:417

`Private` _getActiveActions

_getActiveActions(allActions): ITimelineAction[]
Parameters
- allActions: ITimelineAction[]
Returns ITimelineAction[]
- Defined in eligius-engine.ts:423

`Private` _getTimelineActionsForCurrentTimeline

_getTimelineActionsForCurrentTimeline(): ITimelineAction[]
Returns ITimelineAction[]
- Defined in eligius-engine.ts:445

`Private` _getTimelineActionsForUri

_getTimelineActionsForUri(uri): ITimelineAction[]
Parameters
- uri: string
Returns ITimelineAction[]
- Defined in eligius-engine.ts:453

`Private` _handleRequestEngineRoot

_handleRequestEngineRoot(engineRootSelector, resultCallback): void
Parameters
- engineRootSelector: string
- resultCallback: TResultCallback
Returns void
- Defined in eligius-engine.ts:353

`Private` _handleRequestTimelinePosition

_handleRequestTimelinePosition(floor, resultCallback): void
Parameters
- floor: Function
- resultCallback: TResultCallback
Returns void
- Defined in eligius-engine.ts:437

`Private` _handleRequestTimelineUri

_handleRequestTimelineUri(uri, position?): Promise<void>
Parameters
- uri: string
- position: number = 0
Returns Promise<void>
- Defined in eligius-engine.ts:357

`Private` _handleTimelineComplete

_handleTimelineComplete(): void
Returns void
- Defined in eligius-engine.ts:441

`Private` _initializeTimelinePosition

_initializeTimelinePosition(lookup, position): ActionMethod[]
Parameters
- lookup: Record<number, ActionMethod[]>
- position: number
Returns ActionMethod[]
- Defined in eligius-engine.ts:334

`Private` _initializeTimelineProvider

_initializeTimelineProvider(): Promise<ITimelineProvider>
Returns Promise<ITimelineProvider>
- Defined in eligius-engine.ts:71

`Private` _initializeUriLookup

_initializeUriLookup(lookup, uri): Record<number, any>
Parameters
- lookup: Record<string, Record<number, ActionMethod[]>>
- uri: string
Returns Record<number, any>
- Defined in eligius-engine.ts:323

`Private` _onCompleteCallback

_onCompleteCallback(): void
Returns void
- Defined in eligius-engine.ts:100

`Private` _onFirstFrameCallback

_onFirstFrameCallback(): void
Returns void
- Defined in eligius-engine.ts:104

`Private` _onRestartCallback

_onRestartCallback(): void
Returns void
- Defined in eligius-engine.ts:109

`Private` _onTimeHandler

_onTimeHandler(floor, position): void
Parameters
- floor: ((x) => number)
  - - (x): number
    - Parameters
      x: number
      Returns number
- position: number
Returns void
- Defined in eligius-engine.ts:460

`Private` _pauseRequest

_pauseRequest(): void
Returns void
- Defined in eligius-engine.ts:209

`Private` _playRequest

_playRequest(): void
Returns void
- Defined in eligius-engine.ts:227

`Private` _requestCurrentTimeline

_requestCurrentTimeline(resultCallback): void
Parameters
- resultCallback: TResultCallback
Returns void
- Defined in eligius-engine.ts:449

`Private` _stopRequest

_stopRequest(): void
Returns void
- Defined in eligius-engine.ts:218

`Private` _toggleplay

_toggleplay(): void
Returns void
- Defined in eligius-engine.ts:236

`Private` containerRequest

containerRequest(callBack): void
Parameters
- callBack: TResultCallback
Returns void
- Defined in eligius-engine.ts:205

destroy

destroy(): Promise<void>
Cleans up all the necessary parts that the engine initialized.
- It ends the currently active operations and the init actions.
- It removes all its eventbus listeners, handlers and interceptors.
- It destroys all of its timeline providers
- It empties the HTML element indicated by the containerSelector configuration property.
Returns Promise<void>
Implementation of IEligiusEngine.destroy
- Defined in eligius-engine.ts:126

`Private` durationRequest

durationRequest(callBack): void
Parameters
- callBack: TResultCallback
Returns void
- Defined in eligius-engine.ts:201

init

init(): Promise<ITimelineProvider>
Initializes the engine by creating the HTML layout and the first time line by executing its initActions.

Returns Promise<ITimelineProvider>
Implementation of IEligiusEngine.init
- Defined in eligius-engine.ts:40

`Private` seekRequest

seekRequest(position): Promise<void>
Parameters
- position: number
Returns Promise<void>
- Defined in eligius-engine.ts:174

`Static` sortActionsPerPosition

sortActionsPerPosition(actions): ActionMethod[]
Parameters
- actions: ActionMethod[]
Returns ActionMethod[]
- Defined in eligius-engine.ts:272

`Static` sortTimelines

sortTimelines(timelines): void
Parameters
- timelines: Record<number, ActionMethod[]>[]
Returns void
- Defined in eligius-engine.ts:264

Class EligiusEngine

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: IResolvedEngineConfiguration

eventbus: IEventbus

timelineProviders: Record<TimelineTypes, ITimelineProviderInfo>

languageManager: LanguageManager

Returns EligiusEngine

Properties

Private _activeTimelineProvider

Private _currentTimelineUri

Private _eventbusRemovers

Private _lastPosition

Private _timeLineActionsLookup

Private configuration

Private eventbus

Private languageManager

Private timelineProviders

Methods

Private _addEventListener

Parameters

eventName: string

eventHandler: TEventHandler

Optional eventTopic: string

Returns void

Private _addEventbusListeners

Returns void

Private _addTimelineActionEnd

Parameters

uri: string

timeLineAction: ITimelineAction

Returns void

Private _addTimelineActionStart

Parameters

uri: string

timeLineAction: ITimelineAction

Returns void

Private _cleanUp

Returns Promise<void>

Private _cleanUpTimeline

Returns Promise<void>

Private _createLayoutTemplate

Returns void

Private _createTimelineLookup

Returns void

Private _executeActions

Parameters

actions: IEndableAction[]

methodName: "start" | "end"

idx: number = 0

Returns Promise<void>

Private _executeActionsForPosition

Parameters

position: number

Returns void

Private _executeRelevantActions

Parameters

filter: ((actions) => ITimelineAction[])

Parameters

actions: ITimelineAction[]

Returns ITimelineAction[]

executionType: "start" | "end"

Returns Promise<void>

Private _executeSeekActions

Parameters

position: number

Returns Promise<void>

Private _executeStartActions

Returns Promise<void>

Private _getActionsForPosition

Parameters

position: number

actions: ITimelineAction[]

`Private` _activeTimelineProvider

`Private` _currentTimelineUri

`Private` _eventbusRemovers

`Private` _lastPosition

`Private` _timeLineActionsLookup

`Private` configuration

`Private` eventbus

`Private` languageManager

`Private` timelineProviders

`Private` _addEventListener

`Optional` eventTopic: string

`Private` _addEventbusListeners

`Private` _addTimelineActionEnd

`Private` _addTimelineActionStart

`Private` _cleanUp

`Private` _cleanUpTimeline

`Private` _createLayoutTemplate

`Private` _createTimelineLookup

`Private` _executeActions

`Private` _executeActionsForPosition

`Private` _executeRelevantActions

`Private` _executeSeekActions

`Private` _executeStartActions

`Private` _getActionsForPosition

`Private` _getActiveActions

`Private` _getTimelineActionsForCurrentTimeline

`Private` _getTimelineActionsForUri

`Private` _handleRequestEngineRoot

`Private` _handleRequestTimelinePosition

`Private` _handleRequestTimelineUri

`Private` _handleTimelineComplete

`Private` _initializeTimelinePosition

`Private` _initializeTimelineProvider

`Private` _initializeUriLookup

`Private` _onCompleteCallback

`Private` _onFirstFrameCallback

`Private` _onRestartCallback

`Private` _onTimeHandler

`Private` _pauseRequest

`Private` _playRequest

`Private` _requestCurrentTimeline

`Private` _stopRequest

`Private` _toggleplay

`Private` containerRequest