@realsee/five/vue/hooks/useFiveProject2d.d.ts

Realsee Renderer SDK

import * as THREE from "three";
import { Ref } from "vue";
type Project2d = (vector3: THREE.Vector3 | Ref<THREE.Vector3>, testModel: boolean) => Ref<THREE.Vector2 | null>;
/**
 * Five Vue Hooks: 计算三维坐标对应到屏幕二维坐标
 *
 * @function project2d
 * ```
 * 计算三维坐标对应到屏幕二维坐标
 * `useFiveProject2d()` 通过 watch 监听入参和 cameraUpdate 变化，自动更新返回值
 * 多次调用时会创建多个 watch 监听，推荐 const { project2d } = useFiveAction();
 * // param vector 三维的坐标
 * // param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null
 * // returns 三维的坐标 或者 null
 * project2d(vector: THREE.Vector3 | Ref<THREE.Vector3>, testModel: boolean)
 * v2: Ref<THREE.Vector2 | null>
 * ```
 *
 * @example
 * ```
 * const project2d  = useFiveProject2d();
 * project2d(new THREE.Vector3(0, 0, 0));
 * ```
 */
declare function useFiveProject2d(): Project2d;
export { useFiveProject2d, Project2d };