@threlte/extras/dist/components/controls/TrackballControls/useTrackballControls.d.ts

Utilities, abstractions and plugins for your Threlte apps

import type { TrackballControls } from 'three/examples/jsm/controls/TrackballControls.js';
/**
 * ### `useTrackballControls`
 *
 * Access the `TrackballControls` instance created by the `<TrackballControls>`
 * component mounted within the current `<Canvas>`. Useful for reading or
 * mutating the controls (`target`, `enabled`, `update`, …) from sibling or
 * parent components without a `bind:ref`.
 *
 * `current` is `undefined` until `<TrackballControls>` has mounted, and again
 * after it unmounts, so reads are always safe.
 *
 * ```svelte
 * <script>
 *   import { useTrackballControls } from '@threlte/extras'
 *
 *   const controls = useTrackballControls()
 *
 *   const reset = () => {
 *     controls.current?.reset()
 *   }
 * </script>
 * ```
 */
export declare const useTrackballControls: () => {
    readonly current: TrackballControls | undefined;
};