@realsee/five 6.8.0-alpha.2 → 6.8.0-alpha.21

package/react/hooks/useFiveFloor.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Five React Hooks: Five 楼层
+ * @returns
+ * [ shownFloor: Five 当前显示的楼层， null 为都显示, showFloor: 设置显示楼层，不传参数为都显示 ]
+ * @example
+ * ```
+ * const [ shownFloor, showFloor ] = useFiveFloor;
+ * ```
+ */
+declare function useFiveFloor(): [
+    shownFloor: number | null,
+    totalFloorLength: number,
+    showFloor: (floorIndex?: number) => void
+];
+export { useFiveFloor };

package/react/hooks/useFiveHelper.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Five React Hooks: Five 帮助元素的隐藏/显示
+ * @returns
+ * [ helperVisible: Five 帮助元素是否显示显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]
+ * @example
+ * ```
+ * const [ helperVisible, toggleHelperVisible ] = useFiveHelper;
+ * ```
+ */
+declare function useFiveHelper(): [
+    helperVisible: boolean,
+    toggleHelperVisible: (visible: boolean) => void
+];
+export { useFiveHelper };

package/react/hooks/useFiveModelBounding.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Five React Hooks: 获取当前模型的包围盒
+ */
+declare function useFiveModelBounding(): import("three").Box3;
+export { useFiveModelBounding };

package/react/hooks/useFiveModelEffect.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import { Model } from "@realsee/five";
+/**
+ * Five React Hooks: 操作 Five 的 Model
+ * @param callback - 获取 Five 的 Model 的回调函数
+ * @example
+ * ```
+ * useFiveModelEffect(model => {
+ *  return () => {}; // 析构函数
+ * });
+ * ```
+ */
+declare function useFiveModelEffect(callback: (model: Model) => void | (() => void), deps?: React.DependencyList | undefined): void;
+export { useFiveModelEffect };

package/react/hooks/useFiveModelIntersectRaycaster.d.ts

@@ -0,0 +1,22 @@
+import * as THREE from "three";
+import { Intersection } from "@realsee/five";
+/**
+ * Five React Hooks: 获取当前模型碰撞检测方法
+ *
+ * @function fiveModelIntersectRaycaster
+ * ```
+ * 计算模型射线碰撞检测
+ * // param raycaster THREE 射线对象
+ * // param floors 和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测
+ * // returns 返回碰撞
+ * intersectRaycaster(raycaster: THREE.Raycaster, floors?: number | number[]): Intersection[]
+ * ```
+ *
+ * @example
+ * ```
+ * const fiveModelIntersectRaycaster = useFiveModelIntersectRaycaster();
+ * const intersects = fiveModelIntersectRaycaster(raycaster);
+ * ```
+ */
+declare function useFiveModelIntersectRaycaster(): (raycaster: THREE.Raycaster) => Intersection[];
+export { useFiveModelIntersectRaycaster };

package/react/hooks/useFiveModelReadyState.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Five React Hooks: 获取当前模型加载状态
+ * @returns
+ * "Loaded": 加载完成
+ * "Empty" 加载未完成
+ */
+declare function useFiveModelReadyState(): "Empty" | "Loaded";
+export { useFiveModelReadyState };

package/react/hooks/useFiveProject2d.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Five React Hooks: 将三维的坐标对应到而为屏幕
+ *
+ * @function preject2d
+ * ```
+ * 计算模型射线碰撞检测
+ * // param vector 三维的坐标
+ * // param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null
+ * // returns 三维的坐标 或者 null
+ * preject2d(vector: THREE.Vector3, testModel: boolean): THREE.Vector2 ｜ null
+ * ```
+ *
+ * @example
+ * ```
+ * const preject2d = useFiveProject2d();
+ * const { x: width, y: height } = preject2d(new THREE.Vector3(0, 0, 0));
+ * ```
+ */
+declare function useFiveProject2d(): (vector: THREE.Vector3, testModel: boolean) => import("three").Vector2;
+export { useFiveProject2d };

package/react/hooks/useFiveSceneEffect.d.ts

@@ -0,0 +1,21 @@
+import * as React from "react";
+import { Scene } from "@realsee/five";
+/**
+ * Five React Hooks: 操作 Five 的 Scene
+ * @param callback - 获取 Five 的 Scene 的回调函数
+ * @example
+ * ```
+ * useFiveSceneEffect(scene => {
+ *  // object is a THREE.Object3D
+ *  scene.add(object);
+ *  return () => scene.remove(object); // 析构函数
+ * });
+ * ```
+ */
+declare function useFiveSceneEffect(callback: (scene: Scene) => void | (() => void), deps?: React.DependencyList | undefined): void;
+/**
+ * @deprecated
+ * 请使用 `useFiveSceneEffect` 替代
+ */
+declare const useFiveScene: typeof useFiveSceneEffect;
+export { useFiveSceneEffect, useFiveScene };

package/react/hooks/useFiveState.d.ts

@@ -0,0 +1,6 @@
+import { State } from "@realsee/five";
+declare function useFiveState(): [
+    state: State,
+    setState: (state: Partial<State> | ((prevState: State) => Partial<State>), immediately?: boolean, userAction?: boolean) => void
+];
+export { useFiveState };

package/react/hooks/useFiveWork.d.ts

@@ -0,0 +1,29 @@
+import { Work, Works, State, FiveLoadOptions } from "@realsee/five";
+/**
+ * Five React Hooks: 获取/设置当前的 Work
+ *
+ * @returns
+ * [ work: 获取当前的 Work, loadWork: 设置 Work ]
+
+* @function loadWork
+ * ```
+ * 加载 Work 数据
+ * // param work Work 数据
+ * // param state 初始化姿态
+ * //  - "inherit" 使用当前姿态
+ * //  - "initial" 使用 Work 数据中的 initial 姿态
+ * //  - State 自定义姿态
+ * // param duration 切换时间
+ * (work: Work, state?: "inherit" | "initial" | Partial<Omit<State, "offset">>, duration?: number) => void
+ * ```
+ *
+ * @example
+ * ```
+ * const [ work, loadWork ] = useFiveWork;
+ * ```
+ */
+declare function useFiveWork(): [
+    works: Works,
+    loadWork: (work: Work | Work[], state?: "inherit" | "initial" | Partial<Omit<State, "offset">>, options?: number | FiveLoadOptions, userAction?: boolean) => Promise<void>
+];
+export { useFiveWork };