@threlte/theatre/dist/studio/useStudio.d.ts

Threlte Components for Theatre, an animation library with a professional motion design toolset

/**
 * ### `useStudio`
 *
 * The hook `useStudio` works just like a regular context-based hook but
 * actually returns a store because the Theatre.js Studio can only be
 * initialized once and therefore is a singleton. This hook can therefore be
 * called anywhere in the application to access the Theatre.js Studio.
 *
 * @example
 * ```svelte
 * <script>
 *   import { useStudio } from '@threlte/theatre'
 *
 *   const studio = useStudio()
 *   $studio?.onSelectionChange((selection) => {
 *     console.log(selection)
 *   })
 * </script>
 * ```
 */
export declare const useStudio: () => import("@threlte/core").CurrentWritable<import("@theatre/studio").IStudio | undefined>;