Class App

Application class to orchestrate the interaction between the individual LocAR classes and the Three.js camera, renderer and scene.

Hierarchy (View Summary)

EventEmitter
- App

Index

Constructors

Properties

camera cameraFeedDimensions deviceOrientationControls eventHandlers locar origHfov renderer scene webcam

Methods

emit matchFovToWebcam off on start syncFovWithWebcam

Constructors

constructor

new App(-: AppOptions): App
Create an App object.
Parameters
- -: AppOptions
  Startup options. Note that you can only specify ONE of cameraOptions and threeObjects, as cameraOptions is intended to configure a new three.js camera, while threeObjects allows you to specify an existing camera, renderer and scene.
Returns App
Overrides EventEmitter.constructor
- Defined in lib/three/app.ts:35

Properties

camera

camera: PerspectiveCamera

cameraFeedDimensions

cameraFeedDimensions: { landHeight: number; landWidth: number } | null

deviceOrientationControls

deviceOrientationControls: DeviceOrientationControls | null

eventHandlers

eventHandlers: Record<string, ((...args: any[]) => void)[]>

locar

locar: LocAR

origHfov

origHfov: number

renderer

renderer: WebGLRenderer

scene

scene: Scene

webcam

webcam: Webcam

Methods

emit

emit(eventName: string, ...params: any[]): void
Emit an event.
Parameters
- eventName: string
  the event to emit.
- ...params: any[]
Returns void
Inherited from EventEmitter.emit
- Defined in lib/three/event-emitter.ts:26

matchFovToWebcam

matchFovToWebcam(
    videoWidth: number,
    videoHeight: number,
    aspectScreen: number,
): void
Set the correct three.js camera field of view based on the proportion of the webcam feed currently visible.
Parameters
- videoWidth: number
  the current video feed width
- videoHeight: number
  the current video feed height
- aspectScreen: number
  the current screen aspect ratio
Returns void
- Defined in lib/three/app.ts:187

off

off(eventName: string, eventHandler: (...args: any[]) => void): void
Remove an event handler.
Parameters
- eventName: string
  the event to remove a handler from.
- eventHandler: (...args: any[]) => void
  the event handler function to remove.
Returns void
Inherited from EventEmitter.off
- Defined in lib/three/event-emitter.ts:37

on

on(eventName: string, eventHandler: (...args: any[]) => void): void
Add an event handler. Overridden from EventEmitter to create a ClickHandler for objectsIntersected event.
Parameters
- eventName: string
  the event to handle.
- eventHandler: (...args: any[]) => void
  the event handler function.
Returns void
Overrides EventEmitter.on
- Defined in lib/three/app.ts:215

start

start(): Promise<LocAR>
Start the app. Must be called after construction.

Returns Promise<LocAR>
Promise resolving with LocAR object. Rejects with object containing code and message.
- Defined in lib/three/app.ts:116

syncFovWithWebcam

syncFovWithWebcam(aspectScreen?: number): void
Sync the Three.js fov with the webcam. It may be necessary to adjust the Three fov to match the proportion of the world currently visible through the webcam, which will vary depending on orientation (portrait or landscape) For example, if the device is in portrait, less of the world horizontally will be visible. Mostly intended to be called internally: if you are developing a pure LocAR app you will not need to call this. However it will be necessary to call this on each frame if another library/framework (typically R3F) has provided the three.js objects (i.e the threeObjects option has been provided to the constructor).
Parameters
- OptionalaspectScreen: number
Returns void
- Defined in lib/three/app.ts:169