Interface ImageInterface

An Image is the panoramic visual representation of a specific point in space.

Images can be thought of as locations that have visual data.

interface ImageInterface {
    datasetLocation: Vector3;
    datasetOrientation: Quaternion;
    fileId: string;
    filePath: string;
    hidden: boolean;
    id: number;
    location: Vector3;
    orientation: Quaternion;
    siteModelEntity: SiteModelEntityInterface;
}

Hierarchy (view full)

Properties

datasetLocation: Vector3

Location in the dataset's coordinate system

datasetOrientation: Quaternion

Orientation in the dataset's coordinate system

fileId: string

File name identifier. An image is saved to disk as various degrees of resolution and under different directories (for each resolution). The fileId identifies the related files across directories.

filePath: string

File path for files of the image. Each image resolution is contained within individual relative subdirectories.

hidden: boolean

Display or hide the location marker in the panoramic and map views. Hiding images can reduce network traffic.

id: number

Entity id number

location: Vector3

Location in the local coordinate system (i.e. the site coordinate system).

orientation: Quaternion

Orientation in the local coordinate system (i.e. the site coordinate system).

siteModelEntity: SiteModelEntityInterface

Site model entity in which the image is located.

Generated using TypeDoc