Interface DataHelper

Collections of data converters for the viewer

interface DataHelper {
    config: ParsedViewerConfig;
    state: ViewerState;
    viewer: Viewer;
    cleanPanoramaOptions(
        options: PanoramaOptions,
        panoData: PanoData,
    ): PanoramaOptions;
    cleanPanoramaPose(panoData: PanoData): SphereCorrection<number>;
    cleanPosition(position: ExtendedPosition): Position;
    cleanSphereCorrection(
        sphereCorrection: SphereCorrection,
    ): SphereCorrection<number>;
    fovToZoomLevel(fov: number): number;
    hFovToVFov(hFov: number): number;
    sphericalCoordsToTextureCoords(position: Position): PanoramaPosition;
    sphericalCoordsToVector3(
        position: Position,
        vector?: Vector3,
        distance?: number,
    ): Vector3;
    sphericalCoordsToViewerCoords(position: Position): Point;
    textureCoordsToSphericalCoords(point: PanoramaPosition): Position;
    vector3ToSphericalCoords(vector: Vector3): Position;
    vector3ToViewerCoords(vector: Vector3): Point;
    vFovToHFov(vFov: number): number;
    viewerCoordsToSphericalCoords(viewerPoint: Point): Position;
    viewerCoordsToVector3(viewerPoint: Point): Vector3;
    zoomLevelToFov(level: number): number;
}

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:345

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:334

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:306

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:323

fovToZoomLevel

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

hFovToVFov

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

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:179

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:200

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:262

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:155

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:213

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:249

vFovToHFov

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

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:241

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:226

zoomLevelToFov

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

Interface DataHelper

Hierarchy

Index

Properties

Methods

Properties

Protected Readonlyconfig

Protected Readonlystate

Protected Readonlyviewer

Methods

cleanPanoramaOptions

Parameters

Returns PanoramaOptions

cleanPanoramaPose

Parameters

Returns SphereCorrection<number>

cleanPosition

Parameters

Returns Position

cleanSphereCorrection

Parameters

Returns SphereCorrection<number>

fovToZoomLevel

Parameters

Returns number

hFovToVFov

Parameters

Returns number

sphericalCoordsToTextureCoords

Parameters

Returns PanoramaPosition

Throws

sphericalCoordsToVector3

Parameters

Returns Vector3

sphericalCoordsToViewerCoords

Parameters

Returns Point

textureCoordsToSphericalCoords

Parameters

Returns Position

Throws

vector3ToSphericalCoords

Parameters

Returns Position

vector3ToViewerCoords

Parameters

Returns Point

vFovToHFov

Parameters

Returns number

viewerCoordsToSphericalCoords

Parameters

Returns Position

viewerCoordsToVector3

Parameters

Returns Vector3

zoomLevelToFov

Parameters

Returns number

Settings

On This Page

`Protected` `Readonly`config

`Protected` `Readonly`state

`Protected` `Readonly`viewer