Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RealityService

A service which manages the reality view. For an app developer, the RealityService instance can be used to set preferences which can affect how the manager selects a reality view.

Hierarchy

  • RealityService

Index

Constructors

constructor

Properties

Private _changeEvent

_changeEvent: Event<object> = new Event<{ previous?: RealityView, current: RealityView }>()

Manager-only. An event that is raised when the current reality is changed.

Private Optional _current

_current: RealityView

Private _default

_default: RealityView

Private _defaultFov

_defaultFov: number = Math.PI / 2

Private Optional _desired

_desired: RealityView

Private _desiredFov

_desiredFov: number | undefined

Private _frameEvent

_frameEvent: Event<SerializedFrameState> = new Event<SerializedFrameState>()

Manager-only. An event that is raised when the current reality emits the next frame state. This event contains pose updates for the entities that are managed by the current reality.

Private _loadID

_loadID: number = -1

Private _loaders

_loaders: RealityLoader[] = []

Private Optional _realitySession

_realitySession: SessionPort

Private _scratchArray

_scratchArray: Array<number> = new Array<number>()

Private _scratchFrustum

_scratchFrustum: unknown = new PerspectiveFrustum()

connectEvent

connectEvent: Event<SessionPort> = new Event<SessionPort>()

An event that is raised when a reality control port is opened.

desiredRealityMap

desiredRealityMap: unknown = new WeakMap<SessionPort, RealityView>()

Manager-only. A map from a managed session to the desired reality

desiredRealityMapInverse

desiredRealityMapInverse: unknown = new WeakMap<RealityView | undefined, SessionPort>()

Manager-only. A map from a desired reality to the session which requested it

Private focusService

focusService: FocusService

realities

realities: Array<RealityView> = new Array<RealityView>()

A collection of known reality views from which the reality service can select.

sessionDesiredRealityChangeEvent

sessionDesiredRealityChangeEvent: Event<object> = new Event<{ session: SessionPort, previous: RealityView|undefined, current: RealityView|undefined }>()

Manager-only. An event that is raised when a session changes it's desired reality.

Private sessionService

sessionService: SessionService

Accessors

changeEvent

  • get changeEvent(): Event<object>

frameEvent

Methods

Private _executeRealityLoader

  • _executeRealityLoader(reality: RealityView, callback: function): void

Private _getLoader

Private _setCurrent

Private _setNextReality

  • _setNextReality(reality?: RealityView, force?: boolean): void

getCurrent

  • Manager-only. Get the current reality view.

    deprecated

    . Use app.context.getCurrentReality()

    Returns RealityView | undefined

getDefaultFov

  • getDefaultFov(): number
  • Get the default fov in radians

    Returns number

getDesired

getDesiredFov

  • getDesiredFov(): number | undefined
  • Get the desired fov in radians

    Returns number | undefined

getMaximumViewport

  • getMaximumViewport(): object

isSupported

  • Manager-only. Check if a type of reality is supported.

    Parameters

    Returns boolean

    true if a handler exists and false otherwise

onGenerateViewFromEyeParameters

onSelectReality

  • Manager-only. Selects the best reality based on the realites requested by all managed sessions. Can be overriden for customized selection.

    Returns RealityView | undefined

    The reality chosen for this context. May be undefined if no realities have been requested.

Protected onZoom

publishFrame

registerLoader

setDefault

setDefaultFov

  • setDefaultFov(fov: number): void
  • Set the default fov in radians, and adjust the desired fov to match the previous desired / default ratio.

    Parameters

    • fov: number

    Returns void

setDesired

setDesiredFov

  • setDesiredFov(fov: number | undefined): void
  • Set a desired fov in radians.

    Parameters

    • fov: number | undefined

    Returns void

setOptionalReferenceFrames

  • setOptionalReferenceFrames(referenceFrames: any[]): void
  • Set the optional reference frames for this app

    Parameters

    • referenceFrames: any[]

    Returns void

setRequiredReferenceFrames

  • setRequiredReferenceFrames(referenceFrames: any[]): void
  • Set the optional reference frames for this app

    Parameters

    • referenceFrames: any[]

    Returns void

zoom

  • zoom(data: object): void

Generated using TypeDoc