Class AssetCameraRenderPlugin

A plugin that manages interactions and operations related to the asset camera.

Hierarchy

RendererPluginBase<Events>
- AssetCameraRenderPlugin

Implements

RendererPlugin

Index

Constructors

constructor

new AssetCameraRenderPlugin(
context: RendererPluginContext,
isDefaultCameraPositionEnabled?: boolean,
): AssetCameraRenderPlugin
Parameters
- context: RendererPluginContext
  The renderer plugin context.
- OptionalisDefaultCameraPositionEnabled: boolean
Returns AssetCameraRenderPlugin
Overrides RendererPluginBase<Events>.constructor
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:34

Properties

`Protected` `Readonly`emitter

emitter: Emitter<Events> = ...

An event emitter for handling custom events.

Methods

addEventListener

addEventListener<K extends "cameraMoved">(
event: K,
listener: (eventData: Events[K]) => void,
): { remove: () => void }
Adds an event listener for a specific event.
Type Parameters
- K extends "cameraMoved"
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns { remove: () => void }
An object with a remove method to unsubscribe the listener.
Inherited from RendererPluginBase.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:20

addManagedListener

addManagedListener(handle: { remove: () => void } | (() => void)): void
Registers an event listener handle to be managed by the plugin. Managed listeners will be automatically removed when the plugin is torn down.
Parameters
- handle: { remove: () => void } | (() => void)
  The event listener handle to manage.
Returns void
Inherited from RendererPluginBase.addManagedListener
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:48

animateCameraToAngledView

animateCameraToAngledView(duration: number): Promise<void>
Animates the camera to the home position while preserving the current yaw angle.
Parameters
- duration: number
Returns Promise<void>
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:122

animateCameraToAssetHome

animateCameraToAssetHome(duration: number): Promise<void>
Animates the camera to the home position. Home position is either computed based on the asset's bounds or set explicitly by setDefaultAssetHome.
Parameters
- duration: number
Returns Promise<void>
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:130

animateCameraToTopDownView

animateCameraToTopDownView(duration: number): Promise<void>
Animates the camera to a top-down view of the map.
Parameters
- duration: number
Returns Promise<void>
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:115

animateLookAt

animateLookAt(
    lookAt: LookAt,
    onlyOrientation: boolean,
    duration?: number,
): Promise<void>
Animates the camera to the specified look-at position.
Parameters
- lookAt: LookAt
- onlyOrientation: boolean
- duration: number = 1000
Returns Promise<void>
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:98

animateLookAtToAssetCenter

animateLookAtToAssetCenter(
lookAt?: Partial<Exclude<LookAt, "ref" | "distance">>,
duration?: number,
): Promise<void>
Animates the camera to look at the center of the asset with a certain pitch, yaw and roll
Parameters
- lookAt: Partial<Exclude<LookAt, "ref" | "distance">> = {}
- duration: number = 1000
Returns Promise<void>
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:105

getCurrentCameraState

getCurrentCameraState(): CameraState
Returns the current camera state, including the eye position, forward vector, and up vector. The returned state is in the reference of the asset.

Returns CameraState
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:155

hookTeardown

hookTeardown(_context: RendererPluginContext): void
Tears down the plugin by removing all managed event listeners and clearing the event emitter. This method is called when the plugin is being destroyed.
Parameters
- _context: RendererPluginContext
  The plugin context provided during teardown.
Returns void
Implementation of RendererPlugin.hookTeardown
Inherited from RendererPluginBase.hookTeardown
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:59

isInViewport

isInViewport(point: Point): boolean
Parameters
- point: Point
Returns boolean
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:84

isLookingDown

isLookingDown(): boolean
Checks if the camera is currently in a top-down view.

Returns boolean
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:91

`Protected`isTornDown

isTornDown(): boolean
Checks if the plugin has been torn down.

Returns boolean
true if the plugin has been torn down, otherwise false.
Inherited from RendererPluginBase.isTornDown
- Defined in asset/renderer/src/lib/Plugin/RendererPluginBase.ts:38

setDefaultAssetHome

setDefaultAssetHome(cameraState?: null | CameraState): void
Sets the default camera state (home position & orientation).

If no default state is explicitly set, it will be computed based on the asset's bounds. The camera state that is passed should be in the reference of the asset.
Parameters
- OptionalcameraState: null | CameraState
  The new default camera state to set. If null is provided, the computed camera state will be used as the home position.
Returns void
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:143

transformCameraStateToAssetRef

transformCameraStateToAssetRef(cameraState: CameraState): CameraState
Transform from RIA map representation to the Asset representation (the case for non-geo-referenced assets)
Parameters
- cameraState: CameraState
Returns CameraState
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:164

transformCameraStateToSupportRef

transformCameraStateToSupportRef(
cameraState: CameraState,
): { eye: Vector3; forward: Vector3; up: Vector3 }
Transform from Asset representation to the RIA map representation
Parameters
- cameraState: CameraState
Returns { eye: Vector3; forward: Vector3; up: Vector3 }
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:173

Class AssetCameraRenderPlugin

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AssetCameraRenderPlugin

Properties

Protected Readonlyemitter

Methods

addEventListener

Type Parameters

Parameters

Returns { remove: () => void }

addManagedListener

Parameters

Returns void

animateCameraToAngledView

Parameters

Returns Promise<void>

animateCameraToAssetHome

Parameters

Returns Promise<void>

animateCameraToTopDownView

Parameters

Returns Promise<void>

animateLookAt

Parameters

Returns Promise<void>

animateLookAtToAssetCenter

Parameters

Returns Promise<void>

getCurrentCameraState

Returns CameraState

hookTeardown

Parameters

Returns void

isInViewport

Parameters

Returns boolean

isLookingDown

Returns boolean

ProtectedisTornDown

Returns boolean

setDefaultAssetHome

Parameters

Returns void

transformCameraStateToAssetRef

Parameters

Returns CameraState

transformCameraStateToSupportRef

Parameters

Returns { eye: Vector3; forward: Vector3; up: Vector3 }

Settings

On This Page

`Protected` `Readonly`emitter

`Protected`isTornDown