Class DataHelper

Collections of data converters for the viewer

Hierarchy

AbstractService
- DataHelper

Index

Properties

config state viewer

Methods

cleanPanoramaPose cleanPosition cleanSphereCorrection fovToZoomLevel isPointVisible sphericalCoordsToTextureCoords sphericalCoordsToVector3 sphericalCoordsToViewerCoords textureCoordsToSphericalCoords vFovToHFov vector3ToSphericalCoords vector3ToViewerCoords viewerCoordsToSphericalCoords viewerCoordsToVector3 zoomLevelToFov

Properties

`Protected` `Readonly` config

config: ParsedViewerConfig

`Protected` `Readonly` state

state: ViewerState

`Protected` `Readonly` viewer

viewer: Viewer

Methods

cleanPanoramaPose

cleanPanoramaPose(panoData): SphereCorrection
Parse the pose angles of the pano data
Parameters
- panoData: PanoData
Returns SphereCorrection
- Defined in packages/core/src/services/DataHelper.ts:292

cleanPosition

cleanPosition(position): Position
Converts pixel position to angles if present and ensure boundaries
Parameters
- position: ExtendedPosition
Returns Position
- Defined in packages/core/src/services/DataHelper.ts:264

cleanSphereCorrection

cleanSphereCorrection(sphereCorrection): SphereCorrection
Ensure a SphereCorrection object is valid
Parameters
- sphereCorrection: SphereCorrection
Returns SphereCorrection
- Defined in packages/core/src/services/DataHelper.ts:281

fovToZoomLevel

fovToZoomLevel(fov): number
Converts vertical FOV to zoom level
Parameters
- fov: number
Returns number
- Defined in packages/core/src/services/DataHelper.ts:35

isPointVisible

isPointVisible(vector): boolean
Checks if a point in the 3D scene is currently visible
Parameters
- vector: Vector3
Returns boolean
- Defined in packages/core/src/services/DataHelper.ts:228
isPointVisible(position): boolean
Checks if a point on the sphere is currently visible
Parameters
- position: Position
Returns boolean
- Defined in packages/core/src/services/DataHelper.ts:233

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(position): PanoramaPosition
Converts spherical radians coordinates to pixel texture coordinates
Parameters
- position: Position
Returns PanoramaPosition

Throws
PSVError when the current adapter does not support texture coordinates
- Defined in packages/core/src/services/DataHelper.ts:137

sphericalCoordsToVector3

sphericalCoordsToVector3(position, vector?, distance?): Vector3
Converts spherical radians coordinates to a Vector3
Parameters
- position: Position
- Optional vector: Vector3
  Optional
- distance: number = SPHERE_RADIUS
Returns Vector3
- Defined in packages/core/src/services/DataHelper.ts:158

sphericalCoordsToViewerCoords

sphericalCoordsToViewerCoords(position): Point
Converts spherical radians coordinates to position on the viewer
Parameters
- position: Position
Returns Point
- Defined in packages/core/src/services/DataHelper.ts:220

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(point): Position
Converts pixel texture coordinates to spherical radians coordinates
Parameters
- point: PanoramaPosition
Returns Position

Throws
PSVError when the current adapter does not support texture coordinates
- Defined in packages/core/src/services/DataHelper.ts:113

vFovToHFov

vFovToHFov(vFov): number
Converts vertical FOV to horizontal FOV
Parameters
- vFov: number
Returns number
- Defined in packages/core/src/services/DataHelper.ts:50

vector3ToSphericalCoords

vector3ToSphericalCoords(vector): Position
Converts a Vector3 to spherical radians coordinates
Parameters
- vector: Vector3
Returns Position
- Defined in packages/core/src/services/DataHelper.ts:171

vector3ToViewerCoords

vector3ToViewerCoords(vector): Point
Converts a Vector3 to position on the viewer
Parameters
- vector: Vector3
Returns Point
- Defined in packages/core/src/services/DataHelper.ts:207

viewerCoordsToSphericalCoords

viewerCoordsToSphericalCoords(viewerPoint): Position
Converts position on the viewer to spherical radians coordinates
Parameters
- viewerPoint: Point
Returns Position
- Defined in packages/core/src/services/DataHelper.ts:199

viewerCoordsToVector3

viewerCoordsToVector3(viewerPoint): Vector3
Converts position on the viewer to a THREE.Vector3
Parameters
- viewerPoint: Point
Returns Vector3
- Defined in packages/core/src/services/DataHelper.ts:184

zoomLevelToFov

zoomLevelToFov(level): number
Converts zoom level to vertical FOV
Parameters
- level: number
Returns number
- Defined in packages/core/src/services/DataHelper.ts:43

Generated using TypeDoc