Events

viewer2d.viewpoint

Invoked when the user moves the Viewpoint.
The Viewpoint is an optional visual indicator that includes an arrow icon. The Viewpoint accepts mouse and touch events so that users can move it within the 2D viewer. The Viewpoint is typically used in conjunction with the 3D viewer to show the location and orientation of the 3D viewer camera within the 2D viewer.
Example
﻿
Usage
JS
jQuery
const onViewpointChange = function (event, viewpoint) {
  console.log("viewer2d.viewpoint", "viewpoint:", viewpoint);
};

$("#viewer-2d").on("viewer2d.viewpoint", onViewpointChange);
const onViewpointChange = function (event, viewpoint) {
  console.log("viewer2d.viewpoint", "viewpoint:", viewpoint);
};

$("#viewer-2d").on("viewer2d.viewpoint", onViewpointChange);
﻿
Parameters
onViewpointChange
JS
jQuery
Function called when the user moves the Viewpoint.
Type
(event: Object) => Void
event
Name
Type
Description
viewpoint
Object
The current viewpoint
viewpoint
Current direction, location and rotation of the Viewpoint.
The location height is the height of the last shown storey in meters.
Name
Type
Description
direction
﻿Vector3﻿﻿
Orientation of the Viewpoint
location
﻿Vector3﻿﻿
Position of the Viewpoint
rotation
Number
Rotation of the Viewpoint in degrees
Example
JS
{
  direction: {
    x: 1,
    y: 1,
  },
  location: {
    x: -1.0,
    y: 50,
    z: -1.0
  },
  rotation: -90,
}
{
  direction: {
    x: 1,
    y: 1,
  },
  location: {
    x: -1.0,
    y: 50,
    z: -1.0
  },
  rotation: -90,
}
﻿
Function called when the user moves the Viewpoint.
Type
(event: Object, viewpoint: Object) => Void
event
﻿jQuery.Event﻿
viewpoint
Current direction, location and rotation of the Viewpoint.
The location height is the height of the last shown storey in meters.
Name
Type
Description
direction
﻿Vector3﻿﻿
Orientation of the Viewpoint
location
﻿Vector3﻿﻿
Position of the Viewpoint
rotation
Number
Rotation of the Viewpoint in degrees
Example
JS
{
  direction: {
    x: 1,
    y: 1,
  },
  location: {
    x: -1.0,
    y: 50,
    z: -1.0
  },
  rotation: -90,
}
{
  direction: {
    x: 1,
    y: 1,
  },
  location: {
    x: -1.0,
    y: 50,
    z: -1.0
  },
  rotation: -90,
}
﻿
﻿

Type
(event: Object) => Void

Name	Type	Description
viewpoint	Object	The current viewpoint

Name	Type	Description
direction	Vector3	Orientation of the Viewpoint
location	Vector3	Position of the Viewpoint
rotation	Number	Rotation of the Viewpoint in degrees

Type
(event: Object, viewpoint: Object) => Void

Name	Type	Description
direction	Vector3	Orientation of the Viewpoint
location	Vector3	Position of the Viewpoint
rotation	Number	Rotation of the Viewpoint in degrees

Updated 12 Sep 2024

Did this page help you?

viewer2d.select

Box2