@realsee/five 5.0.0-alpha.124 → 5.0.0-alpha.125

package/vue/index.d.ts

@@ -24,7 +24,7 @@ import { WorkObserver } from '@realsee/five';
 /**
  * Five 命令集合
  */
-export declare interface FiveActionReactCallbacks {
+export declare interface FiveActionVueCallbacks {
     /**
      * 移动相机。（不触发点位移动）
      * @description
@@ -125,6 +125,22 @@ width: number;
 height: number;
 } & {}>, {}>;
 
+export declare type FiveModelIntersectRaycaster = (raycaster: Ref<THREE_2.Raycaster> | THREE_2.Raycaster) => Ref<Intersection[]>;
+
+/**
+ * Five 实例化Five 组件
+ *
+ * 在 FiveProvider 下，可以使用 FiveCanvas 来创建渲染画布。
+ * 以及使用 useFiveState useFiveEventCallback等 Five Vue Composition API 来对 FiveProvider 进行操作
+ * @description Five 创建Five实例的组件
+ * @param FiveProviderComponent - Five 参数
+ * @example
+ * ```typescript
+ * <FiveProvider :initialWork="work">
+ *  <FiveCanvas width="512" height="512"/>
+ * </FiveProvider>
+ * ```
+ */
 export declare const FiveProvider: FiveProviderComponent;
 
 export declare type FiveProviderComponent = DefineComponent<{
@@ -145,6 +161,8 @@ export declare type FiveProviderComponent = DefineComponent<{
     five: Readonly<Five>;
 }>;
 
+export declare type Project2d = (vector3: THREE_2.Vector3 | Ref<THREE_2.Vector3>, testModel: boolean) => Ref<THREE_2.Vector2 | null>;
+
 /**
  * Five Vue Hooks: 获取 five 实例
  * @description 不到万不得已，并不推荐直接使用。
@@ -230,17 +248,17 @@ export declare function unsafe__useFiveInject(): Five;
  * const { updateCamera, initBasisLoader, getPixels, render, needsRender, preloadPano } = useFiveAction();
  * ```
  */
-export declare function useFiveAction(): FiveActionReactCallbacks;
+export declare function useFiveAction(): FiveActionVueCallbacks;
 
 /**
  * Five Vue Hooks: 得到当前相机的方向（单位向量）
- * @returns  当前相机的方向的单位向量
+ * @returns  当前相机方向的单位向量
  */
 export declare function useFiveCameraDirection(): Ref<THREE_2.Vector3>;
 
 /**
  * Five Vue Hooks: 得到当前相机的方向（射线对象）
- * @returns 当前相机的方向的射线对象
+ * @returns 当前相机方向的射线对象
  */
 export declare function useFiveCameraRaycaster(): Ref<THREE_2.Raycaster>;
 
@@ -257,7 +275,7 @@ export declare function useFiveCurrentObserver(): Ref<WorkObserver | null>;
 /**
  * Five Vue Hooks: Five 的实时状态
  * @returns
- * [ currentState: Five 的实时状态 Ref<State>, setState: 设置 Five 的状态 ]
+ * [ currentState: Five 的实时状态, setState: 设置 Five 的状态 ]
  * @example
  * ```
  * const [ currentState, setState ] = useFiveCurrentState;
@@ -296,7 +314,7 @@ showFloor: (floorIndex?: number) => void
 /**
  * Five Vue Hooks: Five 帮助元素的隐藏/显示
  * @returns
- * [ helperVisible: Five 帮助元素是否显示显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]
+ * [ helperVisible: Five 帮助元素是否显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]
  * @example
  * ```
  * const [ helperVisible, toggleHelperVisible ] = useFiveHelper;
@@ -328,14 +346,13 @@ export declare function useFiveModelBounding(): Ref<THREE_2.Box3>;
  * // returns 返回碰撞
  * intersectRaycaster(raycaster: THREE.Raycaster, floors?: number | number[]): Intersection[]
  * ```
- *
  * @example
  * ```
  * const fiveModelIntersectRaycaster = useFiveModelIntersectRaycaster();
  * const intersects = fiveModelIntersectRaycaster(raycaster);
  * ```
  */
-export declare function useFiveModelIntersectRaycaster(): (raycaster: Ref<THREE_2.Raycaster> | THREE_2.Raycaster) => Ref<Intersection[]>;
+export declare function useFiveModelIntersectRaycaster(): FiveModelIntersectRaycaster;
 
 /**
  * Five Vue Hooks: 获取当前模型加载状态
@@ -346,25 +363,25 @@ export declare function useFiveModelIntersectRaycaster(): (raycaster: Ref<THREE_
 export declare function useFiveModelReadyState(): Ref<"Loaded" | "Empty">;
 
 /**
- * Five Vue Hooks: 将三维的坐标对应到而为屏幕
+ * Five Vue Hooks: 将三维的坐标对应到二维屏幕
  *
- * @function preject2d
+ * @function project2d
  * ```
  * 计算模型射线碰撞检测
  * // param vector 三维的坐标
  * // param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null
  * // returns 三维的坐标 或者 null
- * preject2d(vector: THREE.Vector3 | Ref<THREE.Vector3>, testModel: boolean)
+ * project2d(vector: THREE.Vector3 | Ref<THREE.Vector3>, testModel: boolean)
  * v2: Ref<THREE.Vector2 | null>
  * ```
  *
  * @example
  * ```
- * const [ v2, preject2d ] = useFiveProject2d();
- * preject2d(new THREE.Vector3(0, 0, 0));
+ * const project2d  = useFiveProject2d();
+ * project2d(new THREE.Vector3(0, 0, 0));
  * ```
  */
-export declare function useFiveProject2d(): (vector3: THREE_2.Vector3 | Ref<THREE_2.Vector3>, testModel: boolean) => Ref<THREE_2.Vector2 | null>;
+export declare function useFiveProject2d(): Project2d;
 
 /**
  * Five Vue Hooks: 获取scene

package/vue/index.js

@@ -1,8 +1,8 @@
 /**
  * @realsee/five
  *
- * Generated: 2022-05-09
- * Version: 5.0.0-alpha.124
+ * Generated: 2022-05-20
+ * Version: 5.0.0-alpha.125
  *
  * Terms:
  * Realsee SDK License Agreement