Class Camera

The virtual Micrio camera

Author

Marcel Duin [email protected]

Copyright

Q42 Internet BV, Micrio, 2015 - 2023

Link

https://micr.io/ , https://q42.nl/en/

Hierarchy

Camera

Properties

`Readonly` center

center: Coords = ...

Current center screen coordinates and scale

Methods

getView

getView(): View
Get the current image view rectangle

Returns
The current screen viewport

Returns View

setView

setView(view: View, noLimit?: boolean): void
Set the screen viewport
Parameters
- view: View
  
  The viewport
- noLimit: boolean = false
  
  Don't restrict the boundaries
Returns void

getCoo

getCoo(x: number, y: number, absolute?: boolean, noLimit?: boolean): Float64Array
Gets the static image XY coordinates of a screen coordinate

Returns
The relative image XY coordinates
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

setCoo

setCoo(x: number, y: number, scale?: number): 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

getXY

getXY(x: number, y: number, abs?: boolean): Float64Array
Gets the static screen XY coordinates of an image coordinate

Returns
The screen XY coordinates in pixels
Parameters
- x: number
  
  The image X coordinate
- y: number
  
  The image Y coordinate
- abs: boolean = false
  
  Use absolute browser window coordinates
Returns Float64Array

getScale

getScale(): number
Get the current image scale

Returns number

getMatrix

getMatrix(x: number, y: number, scale?: number, radius?: number, rotX?: number, rotY?: number, rotZ?: number, transY?: number): Float32Array
Get a custom matrix for 360 placed embeds

Returns
The resulting 4x4 matrix
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
Returns Float32Array

setScale

setScale(s: number): void
Set the current image scale
Parameters
- s: number
  
  The scale
Returns void

getCoverScale

getCoverScale(): number
Get the scale when the image would cover the screen

Returns number

getMinScale

getMinScale(): number
Get the minimum scale

Returns
The minimum scale

Returns number

setMinScale

setMinScale(s: number): void
Sets the minimum scale
Parameters
- s: number
  
  The minimum scale to set
Returns void

isZoomedIn

isZoomedIn(): boolean
Returns true when the camera is zoomed in to the max

Returns boolean

isZoomedOut

isZoomedOut(): boolean
Returns true when the camera is fully zoomed out

Returns boolean

setLimit

setLimit(limit: View): void
Limit camera navigation boundaries
Parameters
- limit: View
  
  The viewport limit
Returns void

set360RangeLimit

set360RangeLimit(x?: number, y?: number): void
Limit camera navigation boundaries
Parameters
- x: number = 0
  
  The viewport width to limit to
- y: number = 0
  
  The viewport height to limit to
Returns void

flyToView

flyToView(view: View, opts?: {
    duration?: number;
    speed?: number;
    progress?: number;
    prevView?: View;
    isJump?: boolean;
    limit?: boolean;
}): Promise<void>
Fly to a specific view

Returns
Promise when the animation is done
Parameters
- view: View
  
  The viewport to fly to
- opts: {
      duration?: number;
      speed?: number;
      progress?: number;
      prevView?: View;
      isJump?: boolean;
      limit?: boolean;
  } = {}
  
  Optional settings
  - Optional duration?: number
    
    A forced duration in ms of the animation
  - Optional speed?: number
    
    A non-default camera speed
  - Optional progress?: number
    
    Set the starting animation progress percentage
  - Optional prevView?: View
    
    Base the progress override on this starting view
  - Optional isJump?: boolean
    
    Zoom out and in during the animation
  - Optional limit?: boolean
    
    Limit the target viewport
Returns Promise<void>

flyToFullView

flyToFullView(duration?: number, speed?: number): Promise<void>
Fly to a full view of the image

Returns
Promise when the animation is done
Parameters
- duration: number = -1
  
  A forced duration in ms of the animation
- speed: number = -1
  
  A non-default camera speed
Returns Promise<void>

flyToCoverView

flyToCoverView(duration?: number, speed?: number): Promise<void>
Fly to a screen-covering view of the image

Returns
Promise when the animation is done
Parameters
- duration: number = -1
  
  A forced duration in ms of the animation
- speed: number = -1
  
  A non-default camera speed
Returns Promise<void>

flyToCoo

flyToCoo(coords: Coords, duration?: number, speed?: number, limited?: boolean): Promise<void>
Fly to the specific coordinates

Returns
Promise when the animation is done
Parameters
- coords: Coords
  
  The X, Y and scale coordinates to fly to
- duration: number = -1
  
  A forced duration in ms of the animation
- speed: number = -1
  
  A non-default camera speed
- limited: boolean = false
  
  Limit the camera to the image boundaries
Returns Promise<void>

jumpToView

jumpToView(view: View, duration?: number, speed?: number): Promise<void>
Do a "jump" animation to the specific view

Returns
Promise when the animation is done
Parameters
- view: View
  
  The viewport to fly to
- duration: number = -1
  
  A forced duration in ms of the animation
- speed: number = 1
  
  A non-default camera speed
Returns Promise<void>

zoom

zoom(delta: number, duration?: number, x?: number, y?: number, speed?: number, noLimit?: boolean): Promise<void>
Do a zooming animation

Returns
Promise when the zoom animation is done
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>

zoomIn

zoomIn(factor?: number, duration?: number, speed?: number): Promise<void>
Zoom out a factor

Returns
Promise when the zoom animation is done
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>

zoomOut

zoomOut(factor?: number, duration?: number, speed?: number): Promise<void>
Zoom out a factor

Returns
Promise when the zoom animation is done
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>

pan

pan(x: number, y: number, duration?: number): 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
Returns void

stop

stop(): void
Stop any animation

Returns void

pause

pause(): void
Pause any animation

Returns void

resume

resume(): void
Pause any animation

Returns void

getDirection

getDirection(): number
Get the current direction facing in 360 mode in radians

Returns number

setDirection

setDirection(yaw: number, pitch?: number): void
Sets the 360 viewing direction in radians
Parameters
- yaw: number
  
  The direction in radians
- Optional pitch: number
  
  Optional pitch in radians
Returns void

getPitch

getPitch(): number
Get the current direction pitch

Returns
The current pitch in radians

Returns number

setArea

setArea(v: View, direct?: boolean, noDispatch?: boolean): void
Set the relative View to render to
Parameters
- v: View
- direct: boolean = false
- noDispatch: boolean = false
Returns void

Class Camera

Author

Copyright

Link

Hierarchy

Index

Properties

Methods

Properties

Readonly center

Methods

getView

Returns

Returns View

setView

Parameters

view: View

noLimit: boolean = false

Returns void

getCoo

Returns

Parameters

x: number

y: number

absolute: boolean = false

noLimit: boolean = false

Returns Float64Array

setCoo

Parameters

x: number

y: number

scale: number = ...

Returns void

getXY

Returns

Parameters

x: number

y: number

abs: boolean = false

Returns Float64Array

getScale

Returns number

getMatrix

Returns

Parameters

x: number

y: number

Optional scale: number

Optional radius: number

Optional rotX: number

Optional rotY: number

Optional rotZ: number

Optional transY: number

Returns Float32Array

setScale

Parameters

s: number

Returns void

getCoverScale

Returns number

getMinScale

Returns

Returns number

setMinScale

Parameters

s: number

Returns void

isZoomedIn

Returns boolean

isZoomedOut

Returns boolean

setLimit

Parameters

limit: View

Returns void

set360RangeLimit

Parameters

x: number = 0

y: number = 0

Returns void

`Readonly` center

`Optional` scale: number

`Optional` radius: number

`Optional` rotX: number

`Optional` rotY: number

`Optional` rotZ: number

`Optional` transY: number

opts: {
duration?: number;
speed?: number;
progress?: number;
prevView?: View;
isJump?: boolean;
limit?: boolean;
} = {}

`Optional` duration?: number

`Optional` speed?: number

`Optional` progress?: number

`Optional` prevView?: View

`Optional` isJump?: boolean

`Optional` limit?: boolean