@recative/ap-core

Index

Classes

• AlreadyDestroyedError
• AtomStore
• ContextNotInitializedForProtocolConnectorError
• DataSource
• EventTarget2
• InitializeQueueClosedError
• InternalEventName
• NoMatchedResourceError
• RemoteStoreRegistry
• ResourceNotFoundError
• ResourceTracker
• RuntimeSafeResourceTracker
• SmartAnimatedSprite
• SmartSprite
• Stylesheet
• TimeMagic
• UnknownError

Enumerations

• FrameOrderLevel
• FrameRateLevel

Functions

• AtomDefinition
• DefaultTagDataSource
• EventDefinition
• FunctionalAtomDefinition
• Receiver
• RegistryStyleEvent
• RemoteAtomDefinition
• SayImage
• SayOptions
• StyleDefinition
• StyleStore
• bindAppToPlayerEvent
• clearScene
• connectThreeAppToPixiApp
• connectToHost
• createActPointManager
• createComponentContext
• createEmptyApp
• createPixiApp
• createThreeApp
• defaultQueryFn
• getContext
• isDataSourceNodeController
• removeContext
• setContext
• useAnime
• useAnimeTimeline
• useAppDestroyCallback
• useAsyncDataSource
• useBatchPaint
• useCallback
• useCombinator
• useContext
• useDataSource
• useDestroyCallback
• useDialog
• useDialogActiveCallback
• useDialogMessageCallback
• useEnvVariableDataSource
• useEnvVariableGetter
• useEnvVariableUpdateCallback
• useEnvironmentVariableUpdateCallback
• useEventCoordinateTransformer
• useEventTarget
• useFinishedPaymentCallback
• useHideProgressCallback
• useHostFunctions
• useI18FixerDataSource
• useInterval
• useLerp
• useLerpDataSource
• usePauseCallback
• usePlayingCallback
• useQuery
• useRaf
• useRemoteJsonDataSource
• useRemoteStore
• useResolutionUpdateCallback
• useResourceBridgeFunctions
• useResourceManagerI18FixerCustomSprite
• useResourceManagerI18FixerDataSource
• useResourceManagerI18FixerDataSourceAnimatedSprite
• useResourceManagerI18FixerDataSourceTexture
• useResourceManagerI18FixerDataSourceThreeTexture
• useResourceManagerResourceDataSource
• useResourceManagerResourceDataSourceFallbackMode
• useResourceManagerResourceDataSourceNormalMode
• useResourceMetadataByIdFetcher
• useResourceMetadataByIdFetcherFallbackMode
• useResourceMetadataByIdFetcherNormalMode
• useResourceMetadataByLabelFetcher
• useResourceMetadataByLabelFetcherFallbackMode
• useResourceMetadataByLabelFetcherNormalMode
• useResourceTracker
• useResourceUrlByIdFetcher
• useResourceUrlByIdFetcherFallbackMode
• useResourceUrlByIdFetcherNormalMode
• useSeekProgressCallback
• useSelector
• useShowActPointCallback
• useSmartResourceDataSource
• useStore
• useStyleSheet
• useThreeAppConnectCallback
• useThrottle
• useTicker
• useTimeout
• useToggleAnime
• useUploader
• useVideoModalCloseCallback

Interfaces

• CustomEventListener
• FunctionAtomName
• FunctionComponentProps
• IClosedVideoModalEventDetail
• IComponentContext
• IConnectedThreeAppEventDetail
• IDestroyable
• IDialogMessageEventDetail
• IEmptyAppOptions
• IEnabledOrbitControlEvent
• IEnvVariable
• IEpisode
• IFailedResponse
• IFinishedPaymentEventDetail
• ILifeCycleProps
• IOptionItem
• IPixiAppOptions
• IResolutionUpdateEventDetail
• ISave
• ISayButton
• ISeekEventDetail
• ISequenceEndedEventDetail
• ISuccessResponse
• IThreeAppOptions
• IUpdateTextFieldEventDetail
• IVideoModalClosedEventDetail
• PureAtomName
• RemoteAtomName
• SmartAnimatedSpriteOption
• SmartSpriteOption

Type Aliases

• AtomName
• DataSourceNode
• DataSourceNodeController
• EventDetail
• EventName
• FC
• FCP
• FunctionComponent
• IEmptyApp
• IPixiApp
• IPixiThreeConnector
• IThreeApp
• PixiFC
• PixiFunctionComponent
• QueryResult
• Subscribable
• SubscribeFunction
• Subscriber
• TLifeCycle
• TPostProcessing
• TickCallback

Variables

• ACT_POINT_PLAYING
• ACT_POINT_SHOWN
• APP_INITIALIZED
• CHECK_SMART_TEXTURE_RELEASE
• CONNECTED_THREE_APP
• DEFAULT_FRAME_ORDER_LEVEL
• DEFAULT_FRAME_RATE_LEVEL
• DESTROY
• DESTROYED_APP
• DESTROYED_EMPTY_APP
• DEV_MODE
• DIALOG_ACTION_TRIGGERED
• DIALOG_AREA_CLOSED
• DIALOG_AREA_OPENED
• DIALOG_MESSAGE
• ENABLED_ORBIT_CONTROL
• ENV_VARIABLE_STORE
• ENV_VARIABLE_UPDATE
• FINISHED_PAYMENT
• HIDE
• HOST_FUNCTIONS_STORE
• INITIALIZE_TASK_STORE
• NEW_INITIALIZE_TASK
• PAUSE
• PIXI_APP_INSTANCE_TYPE
• PIXI_OPTIONS_STORE
• PLAY
• PRELOAD_ACT_POINT
• RAW_PIXI_APP_STORE
• RESOLUTION_UPDATE
• SEEK
• SEQUENCE_ENDED
• SHOW_ACT_POINT
• STAGE_STORE
• TEXT_FIELD_UPDATE
• THREE_APP_INSTANCE_TYPE
• VIDEO_MODAL_CLOSED

Type Aliases

AtomName

AtomName<T>: PureAtomName<T> | FunctionAtomName<T>

Type parameters

• T

DataSourceNode

DataSourceNode<T>: (subscriber: Subscriber<T>) => { getter: () => T; unsubscribe: () => void }

Type parameters

• T

Type declaration

• • (subscriber: Subscriber<T>): { getter: () => T; unsubscribe: () => void }

  • Parameters

    • subscriber: Subscriber<T>

    Returns { getter: () => T; unsubscribe: () => void }

    • getter: () => T

      • • (): T

        • Returns T

    • unsubscribe: () => void

      • • (): void

        • Returns void

DataSourceNodeController

DataSourceNodeController<T>: ReturnType<DataSourceNode<T>>

Type parameters

• T

EventDetail

EventDetail<T>: T extends InternalEventName<infer X> ? X : never

Type parameters

• T

EventName

EventName<T>: InternalEventName<T>

Type parameters

• T

FC

FC: FunctionComponent

FCP

FCP: FunctionComponentProps

FunctionComponent

FunctionComponent: (x: FunctionComponentProps) => THREE.Object3D

Type declaration

• • (x: FunctionComponentProps): THREE.Object3D

  • Parameters

    • x: FunctionComponentProps

    Returns THREE.Object3D

IEmptyApp

IEmptyApp: ReturnType<typeof createEmptyApp>

IPixiApp

IPixiApp: ReturnType<typeof createPixiApp>

IPixiThreeConnector

IPixiThreeConnector: ReturnType<typeof connectThreeAppToPixiApp>

IThreeApp

IThreeApp: ReturnType<typeof createThreeApp>

PixiFC

PixiFC: PixiFunctionComponent

PixiFunctionComponent

PixiFunctionComponent: () => PIXI.DisplayObject

Type declaration

• • (): PIXI.DisplayObject

  • Returns PIXI.DisplayObject

QueryResult

QueryResult<V>: ISuccessResponse<V> | IFailedResponse

Type parameters

• V

Subscribable

Subscribable<T>: SubscribeFunction<T> | DataSourceNode<T>

Type parameters

• T

SubscribeFunction

SubscribeFunction<T>: (subscriber: Subscriber<T>) => void

Type parameters

• T

Type declaration

• • (subscriber: Subscriber<T>): void

  • Parameters

    • subscriber: Subscriber<T>

    Returns void

Subscriber

Subscriber<T>: (val: T) => void

Type parameters

• T

Type declaration

• • (val: T): void

  • Parameters

    • val: T

    Returns void

TLifeCycle

TLifeCycle: (props: ILifeCycleProps, x?: number) => void

Type declaration

• • (props: ILifeCycleProps, x?: number): void

  • Parameters

    • props: ILifeCycleProps

    • optionalx: number

    Returns void

TPostProcessing

TPostProcessing: (x: EffectComposer, props: ILifeCycleProps & { renderPass: RenderPass }) => void

Type declaration

• • (x: EffectComposer, props: ILifeCycleProps & { renderPass: RenderPass }): void

  • Parameters

    • x: EffectComposer

    • props: ILifeCycleProps & { renderPass: RenderPass }

    Returns void

TickCallback

TickCallback: (timestamp: number, deltaTime: number, ticksElapsed: number) => void

Type declaration

• • (timestamp: number, deltaTime: number, ticksElapsed: number): void

  • Function that will be for called each tick.

    ---

    Parameters

    • timestamp: number

      Current high-resolution timestamp;

    • deltaTime: number

      Time since last tick, in milliseconds;

    • ticksElapsed: number

    Returns void

Variables

constACT_POINT_PLAYING

ACT_POINT_PLAYING: PureAtomName<boolean> = ...

constACT_POINT_SHOWN

ACT_POINT_SHOWN: PureAtomName<boolean> = ...

constAPP_INITIALIZED

APP_INITIALIZED: InternalEventName<ILifeCycleProps> = ...

constCHECK_SMART_TEXTURE_RELEASE

CHECK_SMART_TEXTURE_RELEASE: InternalEventName<null> = ...

constCONNECTED_THREE_APP

CONNECTED_THREE_APP: PureAtomName<IConnectedThreeAppEventDetail> = ...

constDEFAULT_FRAME_ORDER_LEVEL

DEFAULT_FRAME_ORDER_LEVEL: O0 = FrameOrderLevel.O0

constDEFAULT_FRAME_RATE_LEVEL

DEFAULT_FRAME_RATE_LEVEL: D3 = FrameRateLevel.D3

constDESTROY

DESTROY: InternalEventName<null> = ...

constDESTROYED_APP

DESTROYED_APP: InternalEventName<null> = ...

constDESTROYED_EMPTY_APP

DESTROYED_EMPTY_APP: InternalEventName<null> = ...

constDEV_MODE

DEV_MODE: boolean = ...

constDIALOG_ACTION_TRIGGERED

DIALOG_ACTION_TRIGGERED: InternalEventName<DialogActionTriggerResponse> = ...

constDIALOG_AREA_CLOSED

DIALOG_AREA_CLOSED: InternalEventName<null> = ...

constDIALOG_AREA_OPENED

DIALOG_AREA_OPENED: InternalEventName<null> = ...

constDIALOG_MESSAGE

DIALOG_MESSAGE: InternalEventName<IDialogMessageEventDetail> = ...

constENABLED_ORBIT_CONTROL

ENABLED_ORBIT_CONTROL: InternalEventName<IEnabledOrbitControlEventDetail> = ...

constENV_VARIABLE_STORE

ENV_VARIABLE_STORE: FunctionAtomName<IEnvVariable> = ...

constENV_VARIABLE_UPDATE

ENV_VARIABLE_UPDATE: InternalEventName<IEnvVariable> = ...

constFINISHED_PAYMENT

FINISHED_PAYMENT: InternalEventName<IFinishedPaymentEventDetail> = ...

constHIDE

HIDE: InternalEventName<null> = ...

constHOST_FUNCTIONS_STORE

HOST_FUNCTIONS_STORE: FunctionAtomName<{ result: { initialize: () => _AsyncVersionOf<HostFunctions>; connector: any }; dispose: any; setContext: any }> = ...

constINITIALIZE_TASK_STORE

INITIALIZE_TASK_STORE: FunctionAtomName<Map<string, OpenPromise<void>>> = ...

constNEW_INITIALIZE_TASK

NEW_INITIALIZE_TASK: InternalEventName<Promise<unknown>> = ...

constPAUSE

PAUSE: InternalEventName<null> = ...

constPIXI_APP_INSTANCE_TYPE

PIXI_APP_INSTANCE_TYPE: PIXI_APP = ...

constPIXI_OPTIONS_STORE

PIXI_OPTIONS_STORE: PureAtomName<IPixiAppOptions> = ...

constPLAY

PLAY: InternalEventName<null> = ...

constPRELOAD_ACT_POINT

PRELOAD_ACT_POINT: InternalEventName<null> = ...

constRAW_PIXI_APP_STORE

RAW_PIXI_APP_STORE: PureAtomName<Application> = ...

constRESOLUTION_UPDATE

RESOLUTION_UPDATE: InternalEventName<IResolutionUpdateEventDetail> = ...

constSEEK

SEEK: InternalEventName<ISeekEventDetail> = ...

constSEQUENCE_ENDED

SEQUENCE_ENDED: InternalEventName<ISequenceEndedEventDetail> = ...

constSHOW_ACT_POINT

SHOW_ACT_POINT: InternalEventName<null> = ...

constSTAGE_STORE

STAGE_STORE: PureAtomName<Container> = ...

constTEXT_FIELD_UPDATE

TEXT_FIELD_UPDATE: InternalEventName<IUpdateTextFieldEventDetail> = ...

constTHREE_APP_INSTANCE_TYPE

THREE_APP_INSTANCE_TYPE: THREE_APP = ...

constVIDEO_MODAL_CLOSED

VIDEO_MODAL_CLOSED: InternalEventName<IVideoModalClosedEventDetail> = ...