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

Realsee Renderer SDK

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