Class Camera

Readonly center

aniIsKinetic

• aniIsKinetic(): boolean

• Returns whether the current camera movement is kinetic / rubber banding

  Returns boolean

flyToCoo

• flyToCoo(coords, opts?): Promise<void>

• Fly to the specific coordinates

  Parameters

  • coords: Coords

    The X, Y and scale coordinates to fly to
  • opts: AnimationOptions = {}

    Animation options

  Returns Promise<void>

  Promise when the animation is done

flyToCoverView

• flyToCoverView(opts?): Promise<void>

• Fly to a screen-covering view of the image

  Parameters

  • opts: AnimationOptions = {}

    Animation options

  Returns Promise<void>

  Promise when the animation is done

flyToFullView

• flyToFullView(opts?): Promise<void>

• Fly to a full view of the image

  Parameters

  • opts: AnimationOptions = {}

    Animation options

  Returns Promise<void>

  Promise when the animation is done

flyToView

• flyToView(view, opts?): Promise<void>

• Fly to a specific view

  Parameters

  • view: View

    The viewport to fly to
  • opts: AnimationOptions & {
        area?: View;
        isJump?: boolean;
        limitZoom?: boolean;
        noTrueNorth?: boolean;
        omniIndex?: number;
        prevView?: View;
        progress?: number;
    } = {}

    Optional animation settings

  Returns Promise<void>

  Promise when the animation is done

getCoo

• getCoo(x, y, absolute?, noLimit?): Float64Array

• Gets the static image XY coordinates of a screen coordinate

  Parameters

  • x: number

    The screen X coordinate in pixels
  • y: number

    The screen Y coordinate in pixels
  • absolute: boolean = false

    Use absolute browser window coordinates
  • noLimit: boolean = false

    Allow to go out of image bounds

  Returns Float64Array

  The relative image XY coordinates

getCoverLimit

• getCoverLimit(): boolean

• Get whether the image always fills the screen or not

  Returns boolean

getCoverScale

• getCoverScale(): number

• Get the scale when the image would cover the screen

  Returns number

getDirection

• getDirection(): number

• Get the current direction facing in 360 mode in radians

  Returns number

getMatrix

• getMatrix(x, y, scale?, radius?, rotX?, rotY?, rotZ?, transY?, scaleX?, scaleY?): Float32Array

• Get a custom matrix for 360 placed embeds

  Parameters

  • x: number

    The X coordinate
  • y: number

    The Y coordinate
  • Optional scale: number

    The object scale
  • Optional radius: number

    The object radius (default 10)
  • Optional rotX: number

    The object X rotation in radians
  • Optional rotY: number

    The object Y rotation in radians
  • Optional rotZ: number

    The object Z rotation in radians
  • Optional transY: number

    Optional Y translation in 3d space
  • Optional scaleX: number
  • Optional scaleY: number

  Returns Float32Array

  The resulting 4x4 matrix

getMinScale

• getMinScale(): number

• Get the minimum scale

  Returns number

  The minimum scale

getOmniFrame

• getOmniFrame(rot?): number

• [Omni] Get the corresponding frame number to current rotation

  Parameters

  • Optional rot: number

  Returns number

getOmniRotation

• getOmniRotation(): number

• [Omni] Get the current rotation in degrees

  Returns number

getOmniXY

• getOmniXY(x, y, z): Float64Array

• Parameters

  • x: number
  • y: number
  • z: number

  Returns Float64Array

getPitch

• getPitch(): number

• Get the current direction pitch

  Returns number

  The current pitch in radians

getQuad

• getQuad(cX, cY, w, h, rotX?, rotY?, rotZ?, scaleX?, scaleY?): Float32Array

• Parameters

  • cX: number
  • cY: number
  • w: number
  • h: number
  • rotX: number = 0
  • rotY: number = 0
  • rotZ: number = 0
  • scaleX: number = 1
  • scaleY: number = 1

  Returns Float32Array

getScale

• getScale(): number

• Get the current image scale

  Returns number

getView

• getView(): View

• Get the current image view rectangle

  Returns View

  The current screen viewport

getXY

• getXY(x, y, abs?, radius?, rotation?, noTrueNorth?): Float64Array

• Gets the static screen XY coordinates of an image coordinate

  Parameters

  • x: number

    The image X coordinate
  • y: number

    The image Y coordinate
  • abs: boolean = false

    Use absolute browser window coordinates
  • Optional radius: number
  • Optional rotation: number
  • Optional noTrueNorth: boolean

  Returns Float64Array

  The screen XY coordinates in pixels

isZoomedIn

• isZoomedIn(): boolean

• Returns true when the camera is zoomed in to the max

  Returns boolean

isZoomedOut

• isZoomedOut(full?): boolean

• Returns true when the camera is fully zoomed out

  Parameters

  • full: boolean = false

    When using a custom .minSize, use this in the calculation

  Returns boolean

pan

• pan(x, y, duration?, opts?): void

• Pan relative pixels

  Parameters

  • x: number

    The horizontal number of pixels to pan
  • y: number

    The vertical number of pixels to pan
  • duration: number = 0

    An optional duration
  • opts: {
        noLimit?: boolean;
        render?: boolean;
    } = {}

    • Optional noLimit?: boolean

    • Optional render?: boolean

  Returns void

pause

• pause(): void

• Pause any animation

  Returns void

resume

• resume(): void

• Pause any animation

  Returns void

set360RangeLimit

• set360RangeLimit(xPerc?, yPerc?): void

• Limit camera navigation boundaries

  Parameters

  • xPerc: number = 0

    The horizontal arc to limit to, percentage (1 = 360°)
  • yPerc: number = 0

    The vertical arc to limit to, percentage (1 = 180°)

  Returns void

setArea

• setArea(v, opts?): void

• Set the relative Models.Camera.View to render to, animates by default

  Parameters

  • v: View
  • opts: {
        direct?: boolean;
        noDispatch?: boolean;
        noRender?: boolean;
    } = {}

    • Optional direct?: boolean

      Directly set the area without animation

    • Optional noDispatch?: boolean

      Don't emit the updates back to JS

    • Optional noRender?: boolean

      Don't trigger a frame draw

  Returns void

setCoo

• setCoo(x, y, scale?): void

• Sets current coordinates as the center of the screen

  Parameters

  • x: number

    The X Coordinate
  • y: number

    The Y Coordinate
  • scale: number = ...

    The scale to set

  Returns void

setCoverLimit

• setCoverLimit(b): void

• Set the coverLimit of the image to always fill the screen

  Parameters

  • b: boolean

    Limit the image to cover view

  Returns void

setDirection

• setDirection(yaw, pitch?): void

• Sets the 360 viewing direction in radians

  Parameters

  • yaw: number

    The direction in radians
  • Optional pitch: number

    Optional pitch in radians

  Returns void

setLimit

• setLimit(l): void

• Limit camera navigation boundaries

  Parameters

  • l: View

    The viewport limit

  Returns void

setMinScale

• setMinScale(s): void

• Sets the minimum scale

  Parameters

  • s: number

    The minimum scale to set

  Returns void

setMinScreenSize

• setMinScreenSize(s): void

• Sets the minimum screen size you can zoom out to -- this makes you able to zoom out with margins Note: This does not work with albums!

  Parameters

  • s: number

    The minimum screen size [0-1]

  Returns void

setOmniSettings

• setOmniSettings(): void

• Returns void

setRotation

• setRotation(rotX?, rotY?, rotZ?): void

• For in-image 360 embeds

  Parameters

  • rotX: number = 0
  • rotY: number = 0
  • rotZ: number = 0

  Returns void

setScale

• setScale(s): void

• Set the current image scale

  Parameters

  • s: number

    The scale

  Returns void

setView

• setView(v, opts?): void

• Set the screen viewport

  Parameters

  • v: View

    The viewport
  • opts: {
        area?: View;
        correctNorth?: boolean;
        noLimit?: boolean;
        noRender?: boolean;
    } = {}

    Options

    • Optional area?: View

      Custom sub-area

    • Optional correctNorth?: boolean

      [360] Correct the view to trueNorth

    • Optional noLimit?: boolean

      Don't restrict the boundaries

    • Optional noRender?: boolean

      Don't render

  Returns void

stop

• stop(): void

• Stop any animation

  Returns void

zoom

• zoom(delta, duration?, x?, y?, speed?, noLimit?): Promise<void>

• Do a zooming animation

  Parameters

  • delta: number

    The amount to zoom
  • duration: number = 0

    A forced duration in ms of the animation
  • x: number = undefined

    Screen pixel X-coordinate as zoom focus
  • y: number = undefined

    Screen pixel Y-coordinate as zoom focus
  • speed: number = 1

    A non-default camera speed
  • noLimit: boolean = false

    Can zoom outside of the image boundaries

  Returns Promise<void>

  Promise when the zoom animation is done

zoomIn

• zoomIn(factor?, duration?, speed?): Promise<void>

• Zoom out a factor

  Parameters

  • factor: number = 1

    The amount to zoom in
  • duration: number = 250

    A forced duration in ms of the animation
  • speed: number = 1

    A non-default camera speed

  Returns Promise<void>

  Promise when the zoom animation is done

zoomOut

• zoomOut(factor?, duration?, speed?): Promise<void>

• Zoom out a factor

  Parameters

  • factor: number = 1

    The amount to zoom out
  • duration: number = 250

    A forced duration in ms of the animation
  • speed: number = 1

    A non-default camera speed

  Returns Promise<void>

  Promise when the zoom animation is done