useEntityScope

Scope EntityCollection mutations so created entities are removed automatically when the component unmounts.

WARNING

This is a low-level helper that powers useEntity. Prefer useEntity unless you need custom collection management.

Usage

import { Entity } from 'cesium';
import { useEntityScope } from 'vesium';

const { add, remove } = useEntityScope();

const entity = add(new Entity({
  id: 'demo',
}));

// Async creation is also supported.
add(Promise.resolve(new Entity({ id: 'async-demo' })));

Notes

• The target collection defaults to useViewer().value.entities.
• add accepts promises and adds the resolved entity to the collection.
• Use remove when you need manual cleanup before unmounting.

Type Definitions

import type { Entity, EntityCollection } from 'cesium';
import type { MaybeRefOrGetter } from 'vue';
export interface UseEntityScopeOptions {
    /**
     * The collection of Entity to be added
     * @default useViewer().value.entities
     */
    collection?: MaybeRefOrGetter<EntityCollection | undefined>;
}
/**
 * Make `add` and `remove` operations of `EntityCollection` scoped,
 * automatically remove `Entity` instance when component is unmounted.
 */
export declare function useEntityScope(options?: UseEntityScopeOptions): import("..").UseCollectionScopeReturn<Entity, any[], any[], any>;
//# sourceMappingURL=index.d.ts.map