Class DataHelper

Collections of data converters for the viewer

Hierarchy

AbstractService
- DataHelper

Index

Properties

config state viewer

Methods

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

Properties

`Protected` `Readonly`config

config: ParsedViewerConfig

`Protected` `Readonly`state

state: ViewerState

`Protected` `Readonly`viewer

viewer: Viewer

Methods

cleanPanoramaOptions

cleanPanoramaOptions(
options: PanoramaOptions,
panoData: PanoData,
): PanoramaOptions
Update the panorama options if the panorama files contains "InitialView" metadata
Parameters
- options: PanoramaOptions
- panoData: PanoData
Returns PanoramaOptions
- Defined in packages/core/src/services/DataHelper.ts:359

cleanPanoramaPose

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

cleanPosition

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

cleanSphereCorrection

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

fovToZoomLevel

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

hFovToVFov

hFovToVFov(hFov: number): number
Converts horizontal FOV to vertical FOV
Parameters
- hFov: number
Returns number
- Defined in packages/core/src/services/DataHelper.ts:68

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(position: 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:193

sphericalCoordsToVector3

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

sphericalCoordsToViewerCoords

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

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(point: PanoramaPosition): 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:169

vector3ToSphericalCoords

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

vector3ToViewerCoords

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

vFovToHFov

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

viewerCoordsToSphericalCoords

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

viewerCoordsToVector3

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

zoomLevelToFov

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