@realsee/five/react/hooks/useFiveSceneEffect.d.ts

Realsee Renderer SDK

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 };