Interface ImageServiceInterface

interface ImageServiceInterface {
    getClosestImage(location, radius?, smes?): Promise<ImageInterface>;
    getClosestImageInDir(image, currViewingDir, dir, distance): Promise<ImageInterface>;
    getClosestImageOnFloor(location, radius?): Promise<ImageInterface>;
}

Methods

  • 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: Vector2 | Vector3

      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.

    • Optional radius: number

      Radius limit [m].

    • Optional smes: 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.

  • 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.

  • 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.

    • Optional radius: number

      Optionally only within a radius [m].

    Returns Promise<ImageInterface>

    The ImageInterface if found, otherwise rejects.

Generated using TypeDoc