@realsee/five 6.0.0-alpha.1 → 6.0.0-alpha.100

package/react/index.d.ts

@@ -1,8 +1,11 @@
 import { EventCallback } from '@realsee/five';
 import { Five } from '@realsee/five';
 import { FiveInitArgs } from '@realsee/five';
+import { FiveLoadOptions } from '@realsee/five';
 import { Intersection } from '@realsee/five';
 import { Model } from '@realsee/five';
+import { Pano } from '@realsee/five';
+import { PanoId } from '@realsee/five';
 import { Pose } from '@realsee/five';
 import * as React_2 from 'react';
 import { Scene } from '@realsee/five';
@@ -10,7 +13,6 @@ import { State } from '@realsee/five';
 import * as THREE_2 from 'three';
 import { Vector2 } from 'three';
 import { Work } from '@realsee/five';
-import { WorkPanoId } from '@realsee/five';
 import { Works } from '@realsee/five';
 
 export declare function createFiveFeature<T extends FiveInjectionFeature>(...features: T[]): T[];
@@ -34,75 +36,66 @@ export declare function createFiveFeature<T extends FiveInjectionFeature>(...fea
  * ```
  */
 export declare function createFiveProvider(fiveInitArgs?: Omit<FiveInitArgs, "renderer" | "scissor">): {
-    new (props: FiveProviderPropTypes | Readonly<FiveProviderPropTypes>): {
+    new (props: FiveProviderPropTypes): {
         /**
          * five 实例，可以通过 FiveProvider 的 ref.five 获取得到
          * 在一些外部调用方面可以尝试使用
          */
-        five?: Five;
-        unmout: boolean;
-        loadWork(works: Work | Work[], state?: "inherit" | "initial" | Partial<Omit<State, "offset">>, duration?: number, userAction?: boolean): Promise<void>;
-        shouldComponentUpdate(nextProps: FiveProviderPropTypes): boolean;
-        componentWillUnmount(): void;
-        render(): React_2.FunctionComponentElement<React_2.ProviderProps<{
+        state: {
             five: Five;
-            loadWork: (works: Work | Work[], state?: "initial" | "inherit" | Partial<Omit<State, "offset">>, duration?: number, userAction?: boolean) => Promise<void>;
-        }>>;
-        context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<FiveProviderPropTypes>) => {} | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void;
-        forceUpdate(callback?: () => void): void;
-        readonly props: Readonly<FiveProviderPropTypes> & Readonly<{
-            children?: React_2.ReactNode;
-        }>;
-        state: Readonly<{}>;
-        refs: {
-            [key: string]: React_2.ReactInstance;
         };
-        componentDidMount?(): void;
-        componentDidCatch?(error: Error, errorInfo: React_2.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{}>, snapshot?: any): void;
-        componentWillMount?(): void;
-        UNSAFE_componentWillMount?(): void;
-        componentWillReceiveProps?(nextProps: Readonly<FiveProviderPropTypes>, nextContext: any): void;
-        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<FiveProviderPropTypes>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{}>, nextContext: any): void;
-    };
-    new (props: FiveProviderPropTypes, context: any): {
-        /**
-         * five 实例，可以通过 FiveProvider 的 ref.five 获取得到
-         * 在一些外部调用方面可以尝试使用
-         */
-        five?: Five;
-        unmout: boolean;
-        loadWork(works: Work | Work[], state?: "inherit" | "initial" | Partial<Omit<State, "offset">>, duration?: number, userAction?: boolean): Promise<void>;
+        loadArgs: {
+            works: Work | Work[];
+            state?: "inherit" | "initial" | Partial<Omit<State, "offset">>;
+            options?: number | FiveLoadOptions;
+            userAction: boolean;
+            resolve: () => void;
+            reject: (error: any) => void;
+        };
+        loadWork(five: Five, works: Work | Work[], state?: "inherit" | "initial" | Partial<Omit<State, "offset">>, options?: number | FiveLoadOptions, userAction?: boolean): Promise<void>;
         shouldComponentUpdate(nextProps: FiveProviderPropTypes): boolean;
+        componentDidMount(): void;
         componentWillUnmount(): void;
         render(): React_2.FunctionComponentElement<React_2.ProviderProps<{
             five: Five;
-            loadWork: (works: Work | Work[], state?: "initial" | "inherit" | Partial<Omit<State, "offset">>, duration?: number, userAction?: boolean) => Promise<void>;
+            loadWork: (works: Work | Work[], state?: "initial" | "inherit" | Partial<Omit<State, "offset">>, options?: number | FiveLoadOptions, userAction?: boolean) => Promise<void>;
         }>>;
         context: any;
-        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<FiveProviderPropTypes>) => {} | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void;
+        setState<K extends "five">(state: {
+            five: Five;
+        } | ((prevState: Readonly<{
+            five: Five;
+        }>, props: Readonly<FiveProviderPropTypes>) => {
+            five: Five;
+        } | Pick<{
+            five: Five;
+        }, K>) | Pick<{
+            five: Five;
+        }, K>, callback?: () => void): void;
         forceUpdate(callback?: () => void): void;
         readonly props: Readonly<FiveProviderPropTypes> & Readonly<{
             children?: React_2.ReactNode;
         }>;
-        state: Readonly<{}>;
         refs: {
             [key: string]: React_2.ReactInstance;
         };
-        componentDidMount?(): void;
         componentDidCatch?(error: Error, errorInfo: React_2.ErrorInfo): void;
-        getSnapshotBeforeUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{}>): any;
-        componentDidUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{}>, snapshot?: any): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{
+            five: Five;
+        }>): any;
+        componentDidUpdate?(prevProps: Readonly<FiveProviderPropTypes>, prevState: Readonly<{
+            five: Five;
+        }>, snapshot?: any): void;
         componentWillMount?(): void;
         UNSAFE_componentWillMount?(): void;
         componentWillReceiveProps?(nextProps: Readonly<FiveProviderPropTypes>, nextContext: any): void;
         UNSAFE_componentWillReceiveProps?(nextProps: Readonly<FiveProviderPropTypes>, nextContext: any): void;
-        componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{}>, nextContext: any): void;
-        UNSAFE_componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{}>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{
+            five: Five;
+        }>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<FiveProviderPropTypes>, nextState: Readonly<{
+            five: Five;
+        }>, nextContext: any): void;
     };
     contextType?: React_2.Context<any>;
 };
@@ -255,7 +248,7 @@ export declare interface FiveActionReactCallbacks {
      * @param callback - 加载完成回调, 并传递加载用时。
      * @returns 加载完成的 Promise 参数同 callback
      */
-    preloadPano(panoId: WorkPanoId, callback?: (costs: number) => void): Promise<number>;
+    preloadPano(pano: Pano | PanoId | number, callback?: (costs: number) => void): Promise<number>;
 }
 
 /**
@@ -480,6 +473,7 @@ export declare type FiveProviderPropTypes = {
     work?: Work | Work[];
     initialWork?: Work | Work[];
     initialState?: "inherit" | "initial" | Partial<Omit<State, "offset">>;
+    initialOptions?: number | FiveLoadOptions;
     initialUserAction?: boolean;
     onWorksChange?: (works: Works) => void;
     onStateChange?: (state: State, userAction: boolean) => void;