virtualcityMAP 3.6

Class: Oblique

vcs.vcm.maps.Oblique

Oblique Map Class (2D map with oblique imagery)

new vcs.vcm.maps.Oblique(options)

Name Type Description
options vcs.vcm.maps.Oblique.Options

Extends

Members

className{string}

class Name of the Object

mapElement{HTMLElement}

movementDisabled{boolean}

if true, no movements should occur

name{string}

unique Name

Methods

activate(viewPoint){Promise} inherited

activates the map, if necessary initializes the map. this is a dummy method most likely to be overwritten by the specific map class.

Name Type Description
viewPoint vcs.vcm.util.ViewPoint

the optional starting Viewpoint of the map after activation.
Fires:
  • MAP_ACTIVATED (vcs.vcm.maps) - vcs.vcm.event.EventType.MAP_ACTIVATED is triggered when a map is activated (and on each map switch).

activateMouseClickEvents(activate) inherited

activates mouseClick Events on objects

Name Type Description
activate boolean
Deprecated
  • 3.5

    deactivate(){Promise} inherited

    deactivates the map returns the current viewpoint of the map to enable a change between different maps.

    Returns:
    position returns the current viewpoint of the map.

    dispose() inherited

    disposes the map

    getActiveMouseClickEvents(){boolean} inherited

    returns whether mouse click events is activated or not

    Deprecated
    • 3.5

      getClassName(){string} inherited

      returns the class name of this object.

      Deprecated
      • Yes
      Returns:
      className

      getConfigObject(){Object} inherited

      getCurrentImage(){vcs.oblique.Image|null}

      getId(){string} inherited

      returns the id of this object

      Deprecated
      • Yes

      getName(){string} inherited

      returns the name of the Object, the name is either given by the config Object or a uuid is generated

      Deprecated
      • Yes

      getOl3Map(){ol.Map}

      getolMap(){ol.Map}

      returns the ol3 map object

      getViewPoint(optGroundPosition, optPromiseFlag){vcs.vcm.util.ViewPoint|Promise.<vcs.vcm.util.ViewPoint>}

      Name Type Description
      optGroundPosition boolean

      whether to return the ground position or not
      optPromiseFlag boolean

      gotoViewPoint(viewpoint){Promise}

      sets the view to the given viewpoint

      Name Type Description
      viewpoint vcs.vcm.util.ViewPoint

      isActive(){boolean} inherited

      returns if this map is currently active

      isInitialized(){boolean} inherited

      checks if the mapobject is already initialized

      Deprecated
      • 3.5

        isSupported(){boolean} inherited

        checks if the current browser supports the MAP, also checks if all dependencies are there

        Deprecated
        • 3.5

          pointIsVisible(coords){boolean}

          Name Type Description
          coords ol.Coordinate

          in WGS84 degrees

          Type Definitions

          vcs.vcm.maps.Oblique.ClickParameters{Object}

          Properties:
          Name Type Description
          pixel ol.Pixel
          estimate boolean | undefined

          vcs.vcm.maps.Oblique.Options{vcs.vcm.maps.Map.Options}

          Properties:
          Name Type Argument Default Description
          changeOnMoveEnd boolean <optional>
          		 false
          switchThreshold number <optional>
          		 0
          switchOnEdge boolean <optional>
          		 true
          fallbackMap string | undefined

          a fallback map to use, in case there is no oblique image at the activation viewpoint

          Events

          OBLIQUE_FALLBACK_ACTIVATED

          vcs.vcm.event.EventType.OBLIQUE_FALLBACK_ACTIVATED is triggered when no image for the given coordinate has been found. The layer firing the event is added as the event data.