@threlte/core/dist/context/fragments/parent.js

A 3D framework for the web, built on top of Svelte and Three.js

import { getContext, setContext } from 'svelte';
import { currentWritable } from '../../utilities/index.js';
const parentContextKey = Symbol('threlte-parent-context');
/**
 * The parent context is used to access the parent object created by a `<T>`
 * component.
 */
export const createParentContext = (parent) => {
    const ctx = currentWritable(parent);
    setContext(parentContextKey, ctx);
    return ctx;
};
/**
 * The parent context is used to access the parent object created by a `<T>`
 * component.
 *
 * @example
 * ```svelte
 * <T.Mesh>
 *   <CustomComponent />
 * </T.Mesh>
 * ```
 *
 * The parent as retrieved inside the component `<CustomComponent>`
 * will be the mesh created by the `<T.Mesh>` component.
 */
export const useParent = () => {
    const parent = getContext(parentContextKey);
    return parent;
};