Interface ImageServiceInterface

interface ImageServiceInterface {
    getClosestImage(
        location: Vector3 | Vector2,
        radius?: number,
        smes?: SiteModelEntityInterface[],
    ): Promise<ImageInterface>;
    getClosestImageInDir(
        image: ImageInterface,
        currViewingDir: ViewOrientationInterface,
        dir: number,
        distance: number,
    ): Promise<ImageInterface>;
    getClosestImageOnFloor(
        location: Vector3,
        radius?: number,
    ): Promise<ImageInterface>;
}

Index

Methods

getClosestImage getClosestImageInDir getClosestImageOnFloor

Methods

getClosestImage

getClosestImage(
    location: Vector3 | Vector2,
    radius?: number,
    smes?: SiteModelEntityInterface[],
): Promise<ImageInterface>
Finds the closest image for the given local position. Optionally with restriction to the given site model entities (or none if the array contains undefined). Fails if no image is found.
Parameters
- location: Vector3 | Vector2
  Local location around which to get the closest image. Note that 3D vector will sort by absolute distance, so if you want orthographic, pass 2D vector.
- Optionalradius: number
  Radius limit [m].
- Optionalsmes: SiteModelEntityInterface[]
  The site model entities to restrict the search to. Pass an undefined item in the array to include images without a site model entity.
Returns Promise<ImageInterface>
The ImageInterface if found, otherwise rejects.

getClosestImageInDir

getClosestImageInDir(
    image: ImageInterface,
    currViewingDir: ViewOrientationInterface,
    dir: number,
    distance: number,
): Promise<ImageInterface>
Find the closest non-hidden image to the target point. The target point is located in distance (dir * dist) in the direction of view.
Parameters
- image: ImageInterface
  The starting image from which to search.
- currViewingDir: ViewOrientationInterface
  The current viewing direction.
- dir: number
  The direction modifier: +1 for forward, -1 for backward.
- distance: number
  How far away to move to approximately.
Returns Promise<ImageInterface>
The nearest image in the direction at the distance, or reject if none found.

getClosestImageOnFloor

getClosestImageOnFloor(
location: Vector3,
radius?: number,
): Promise<ImageInterface>
This method will look for the closest image on the same floor as the location given. If not within a floor the closest image without a SiteModelEntityInterface will be returned.
Parameters
- location: Vector3
  The local location for which to return the nearest image, on the same floor.
- Optionalradius: number
  Optionally only within a radius [m].
Returns Promise<ImageInterface>
The ImageInterface if found, otherwise rejects.