Class AssetCameraRenderPlugin

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

Hierarchy

RendererPlugin & DisposableManaged & EventBus<Events, this>
- AssetCameraRenderPlugin

Implements

AssetRendererPlugin

Index

Constructors

constructor

Methods

addDisposable addEventListener animateCameraToAngledView animateCameraToAssetHome animateCameraToTopDownView animateLookAt animateLookAtToAssetCenter dispatchEvent getCurrentCameraState hookInitialize? hookRegister? hookTeardown isInViewport isLookingDown isTornDown setDefaultAssetHome transformCameraStateToAssetRef transformCameraStateToSupportRef

Constructors

constructor

new AssetCameraRenderPlugin(
context: AssetRendererPluginContext,
): AssetCameraRenderPlugin
Parameters
- context: AssetRendererPluginContext
  The renderer plugin context.
Returns AssetCameraRenderPlugin
Overrides Mix(DisposableManaged, Evented<Events>()).constructor
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:35

Methods

addDisposable

addDisposable(disposable: Disposable): void
Adds the given Disposable to be owned by this plugin.
Parameters
- disposable: Disposable
Returns void
Inherited from Mix(DisposableManaged, Evented<Events>()).addDisposable
- Defined in renderer-plugin/src/lib/mixins/DisposableManaged.ts:44

addEventListener

addEventListener<K extends "cameraMoved">(
event: K,
listener: (eventData: Events[K]) => void,
): EventHandle
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 EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Inherited from Mix(DisposableManaged, Evented<Events>()).addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:28

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

dispatchEvent

dispatchEvent<K extends "cameraMoved">(...args: DispatchArgsOf<Events, K>): void
Dispatches the given event with given payload on the plugin.
Type Parameters
- K extends "cameraMoved"
Parameters
- ...args: DispatchArgsOf<Events, K>
Returns void
Inherited from Mix(DisposableManaged, Evented<Events>()).dispatchEvent
- Defined in core/src/lib/Event/EventEmitter.ts:50

getCurrentCameraState

getCurrentCameraState(reference?: "ASSET" | "WORLD"): CameraState
Returns the current camera state, including the eye position, forward vector, and up vector.
Parameters
- reference: "ASSET" | "WORLD" = 'ASSET'
  The reference frame for the returned camera state, either 'ASSET' or 'WORLD'. Default is 'ASSET'.
Returns CameraState
- Defined in asset/camera/src/lib/plugin/AssetCameraRenderPlugin.ts:155

`Optional`hookInitialize

hookInitialize?(context: unknown): void
Called by the plugin system is initialized.
Parameters
- context: unknown
  The context provided to the plugin.
Returns void
Implementation of AssetRendererPlugin.hookInitialize
Inherited from Mix(DisposableManaged, Evented<Events>()).hookInitialize
- Defined in renderer-plugin/src/lib/RendererPlugin.ts:16

`Optional`hookRegister

hookRegister?(context: unknown): boolean
Called when the plugin is registered in the system. The result of this hook determines whether the plugin is enabled.
Parameters
- context: unknown
  The context provided to the plugin.
Returns boolean
Whether the plugin should be enabled.
Implementation of AssetRendererPlugin.hookRegister
Inherited from Mix(DisposableManaged, Evented<Events>()).hookRegister
- Defined in renderer-plugin/src/lib/RendererPlugin.ts:9

hookTeardown

hookTeardown(context: unknown): void
Called when the plugin system is manually torn down. This should be used to clean up resources.
Parameters
- context: unknown
  The context provided to the plugin.
Returns void
Implementation of AssetRendererPlugin.hookTeardown
Inherited from Mix(DisposableManaged, Evented<Events>()).hookTeardown
- Defined in renderer-plugin/src/lib/RendererPlugin.ts:23

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

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 Mix(DisposableManaged, Evented<Events>()).isTornDown
- Defined in renderer-plugin/src/lib/mixins/DisposableManaged.ts:39

setDefaultAssetHome

setDefaultAssetHome(cameraState?: CameraState | null): 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: CameraState | null
  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:167

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:176

Class AssetCameraRenderPlugin

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AssetCameraRenderPlugin

Methods

addDisposable

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns EventHandle

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>

dispatchEvent

Type Parameters

Parameters

Returns void

getCurrentCameraState

Parameters

Returns CameraState

OptionalhookInitialize

Parameters

Returns void

OptionalhookRegister

Parameters

Returns boolean

hookTeardown

Parameters

Returns void

isInViewport

Parameters

Returns boolean

isLookingDown

Returns boolean

isTornDown

Returns boolean

setDefaultAssetHome

Parameters

Returns void

transformCameraStateToAssetRef

Parameters

Returns CameraState

transformCameraStateToSupportRef

Parameters

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

Settings

On This Page

`Optional`hookInitialize

`Optional`hookRegister