Class: SpatialComponent
component.SpatialComponent
Hierarchy#
Component<SpatialConfiguration>↳
SpatialComponent
Properties#
componentName#
â–ª Static componentName: ComponentName = "spatial"
Overrides#
Defined in#
component/spatial/SpatialComponent.ts:77
Accessors#
activated#
• get activated(): boolean
Get activated.
Returns#
boolean
Value indicating if the component is currently active.
Defined in#
defaultConfiguration#
• get defaultConfiguration(): TConfiguration
Get default configuration.
Returns#
TConfiguration
Default configuration for component.
Defined in#
name#
• get name(): string
Get name.
description The name of the component. Used when interacting with the
component through the Viewer's API.
Returns#
string
Defined in#
Methods#
configure#
â–¸ configure(configuration): void
Configure the component.
Parameters#
| Name | Type | Description |
|---|---|---|
configuration | SpatialConfiguration | Component configuration. |
Returns#
void
Inherited from#
Defined in#
fire#
â–¸ fire<T>(type, event): void
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type |
|---|---|
type | ComponentEventType |
event | T |
Returns#
void
Inherited from#
Defined in#
getFrameIdAt#
â–¸ getFrameIdAt(pixelPoint): Promise<string>
Returns the image id of the camera frame closest to the current render camera position at the specified point.
description Notice that the pixelPoint argument requires x, y
coordinates from pixel space.
With this function, you can use the coordinates provided by mouse events to get information out of the spatial component.
If no camera frame exist at the pixel
point, null will be returned.
example
spatialComponent.getFrameIdAt([100, 125]) .then((imageId) => { console.log(imageId); });Parameters#
| Name | Type | Description |
|---|---|---|
pixelPoint | number[] | Pixel coordinates on the viewer element. |
Returns#
Promise<string>
Image id of the camera frame closest to
the camera. If no camera frame is intersected at the
pixel point, null will be returned.
Defined in#
component/spatial/SpatialComponent.ts:121
off#
â–¸ off<T>(type, handler): void
Unsubscribe from an event by its name.
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type | Description |
|---|---|---|
type | ComponentEventType | The name of the event to unsubscribe from. |
handler | (event: T) => void | The handler to remove. |
Returns#
void
Inherited from#
Defined in#
on#
â–¸ on<T>(type, handler): void
Subscribe to an event by its name.
Type parameters#
| Name |
|---|
T |
Parameters#
| Name | Type | Description |
|---|---|---|
type | ComponentEventType | The name of the event to subscribe to. |
handler | (event: T) => void | The handler called when the event occurs. |
Returns#
void