Skip to main content

Class: RegionRegistry

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:24

Constructors

Constructor

new RegionRegistry(): RegionRegistry;

Returns

RegionRegistry

Methods

capture()

capture(point: Vec3, origins: ReadonlyMap<string, Vec3>): string | undefined;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:105

Which region captures a drop at point, given each region's current world-space origin? Regions missing from origins are not considered (e.g. their entity is gone this frame).

Parameters

ParameterType
pointVec3
originsReadonlyMap<string, Vec3>

Returns

string | undefined


dock()

dock(windowId: string, regionId: string): number;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:57

Dock a window; returns its slot index.

Parameters

ParameterType
windowIdstring
regionIdstring

Returns

number


get()

get(id: string): RegisteredRegion | undefined;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:52

Parameters

ParameterType
idstring

Returns

RegisteredRegion | undefined


list()

list(): RegisteredRegion[];

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:117

Returns

RegisteredRegion[]


offsetOf()

offsetOf(windowId: string): Vec3 | undefined;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:89

Local-space offset for a docked window, or undefined when not docked.

Parameters

ParameterType
windowIdstring

Returns

Vec3 | undefined


regionOf()

regionOf(windowId: string): string | undefined;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:84

Parameters

ParameterType
windowIdstring

Returns

string | undefined


register()

register(id: string, definition?: Partial<RegionDefinition>): RegisteredRegion;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:28

Parameters

ParameterType
idstring
definitionPartial<RegionDefinition>

Returns

RegisteredRegion


undock()

undock(windowId: string): string | undefined;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:72

Remove a window from whichever region holds it. Later members shift up.

Parameters

ParameterType
windowIdstring

Returns

string | undefined


unregister()

unregister(id: string): void;

Defined in: packages/webxr-uiextensions/src/core/region-registry.ts:41

Parameters

ParameterType
idstring

Returns

void