Type alias RealityAPI

RealityAPI: {
    controls: {
        getAzimuthAngle: (() => number);
        getDistance: (() => number);
        getPolarAngle: (() => number);
        normalizeRotations: (() => void);
        reset: (() => void);
        rotate: ((azimuth, polar, transition?) => void);
        rotateTo: ((azimuth, polar, transition?) => void);
        setDistance: ((distance, transition?) => void);
        setPosition: ((x, y, z, transition?) => void);
        setTarget: ((x, y, z, transition?) => void);
    };
    getCameraPosition: (() => Vector3Tuple);
    getScreenshot: (() => Promise<Blob>);
    load: (() => void);
    triggerAr: ((onARNotSupported) => void);
} & ConfigurationContextType & SceneContextType

Type declaration

  • controls: {
        getAzimuthAngle: (() => number);
        getDistance: (() => number);
        getPolarAngle: (() => number);
        normalizeRotations: (() => void);
        reset: (() => void);
        rotate: ((azimuth, polar, transition?) => void);
        rotateTo: ((azimuth, polar, transition?) => void);
        setDistance: ((distance, transition?) => void);
        setPosition: ((x, y, z, transition?) => void);
        setTarget: ((x, y, z, transition?) => void);
    }
    • getAzimuthAngle: (() => number)
        • (): number
        • Returns number

    • getDistance: (() => number)
        • (): number
        • Returns number

    • getPolarAngle: (() => number)
        • (): number
        • Returns number

    • normalizeRotations: (() => void)
        • (): void
        • Returns void

    • reset: (() => void)
        • (): void
        • Returns void

    • rotate: ((azimuth, polar, transition?) => void)
        • (azimuth, polar, transition?): void
        • Parameters

          • azimuth: number
          • polar: number
          • Optional transition: boolean

          Returns void

    • rotateTo: ((azimuth, polar, transition?) => void)
        • (azimuth, polar, transition?): void
        • Parameters

          • azimuth: number
          • polar: number
          • Optional transition: boolean

          Returns void

    • setDistance: ((distance, transition?) => void)
        • (distance, transition?): void
        • Parameters

          • distance: number
          • Optional transition: boolean

          Returns void

    • setPosition: ((x, y, z, transition?) => void)
        • (x, y, z, transition?): void
        • Parameters

          • x: number
          • y: number
          • z: number
          • Optional transition: boolean

          Returns void

    • setTarget: ((x, y, z, transition?) => void)
        • (x, y, z, transition?): void
        • Parameters

          • x: number
          • y: number
          • z: number
          • Optional transition: boolean

          Returns void

  • getCameraPosition: (() => Vector3Tuple)
      • (): Vector3Tuple
      • Returns Vector3Tuple

  • getScreenshot: (() => Promise<Blob>)
      • (): Promise<Blob>
      • Returns Promise<Blob>

  • load: (() => void)
      • (): void
      • Returns void

  • triggerAr: ((onARNotSupported) => void)
      • (onARNotSupported): void
      • Parameters

        • onARNotSupported: (() => void)
            • (): void
            • Returns void

        Returns void

Generated using TypeDoc