Controls

This wiki is outdated. Use this documentation for Lock View v2+.

Control Buttons

On the left of the screen, there are new control buttons for the GM that display and toggle the current setting on the scene.
From the top to the bottom:

• Set View - Creates a dialog box with options to set the view, see below
• Pan Lock - Shows/switches the current state of 'Pan Lock'. If on, panning is disabled
• Zoom Lock - Shows/switches the current state of 'Zoom Lock'. If on, zooming is disabled
• Bounding Box - Shows/switches the current state of 'Bounding Box'. If on, zoom and pan are limited to the bounding box
• Viewbox - Draws a square on the canvas that shows what enabled users can see. The color of the square corresponds with the 'Player Color'
• Edit Viewbox - Allows the GM to edit a viewbox, and the users' view. Right-click dragging drags a viewbox and pans the viewbox's user sceen, the scrollwheel increases or decreases the size of the viewbox and zooms the screen the user in or out. Additionally, two icons appear next to each viewbox which can be used to zoom or pan the view of the user.

Set View Dialog

After clicking the 'Set View' control button, a dialog box appears that gives multiple options to control the view of users. There's 2 dropdown menu's, and 3 number boxes
Top dropdown menu (X & Y movement)

• Reset to initial view - Resets the view to the initial view position, as set in the scene configuration screen
• Horizontal fit - Scale and move the view so the scene fits horizontally

• Vertical fit - Scale and move the view so the scene fits vertically
• Automatic Fit (inside) - Automatically chooses horizontal or vertical fit so no non-image background will ever be seen
• Automatic Fit (outside) - Automatically chooses horizontal or vertical fit so the full background can be seen, but can show the padding (area outside of the background image)
• Move grid spaces - Moves the view in grid-units, relative to the current view. So setting X to 1 will move the view 1 gridspace to the right
• Move to coordinates - Moves the view to the absolute coordinates as set in the number boxes

Bottom dropdown menu (Zooming)

• Ignore scale - No zooming will occur
• Set scale - Zooms to the scale size set in the 'Scale' box
• Reset scale - Resets the zoom to the initial zoom factor, as set in the scene configuration screen
• Physical gridsize - Automatically scales the gridsize to make it correspond to a physical gridsize (in mm or inch), as set in the module settings

Viewbox

The viewbox is a function that allows the GM so see what users can see.
If enabled (enable for the user in the User Configuration screen in the module settings, and enable the 'Viewbox' control button), a rectangle is drawn that corresponds with the view of the user. The color of the rectangle is the user color, and above the rectangle you can find the user name.

It is possible for the GM to control the view of the users by enabling the 'Edit Viewbox' control button.
If enabled, the GM can either control the view of all enabled users: pan by left-click dragging and zoom by using the scroll wheel.
Or control the view of individual users by dragging the icons next to each viewbox that appear when the 'Edit Viewbox' control button is pressed: Drag the upper-left icon to pan, drag the lower-right icon to zoom.

Macro Control

It is possible to control most of the module's functions through macros (or from other modules):

Hooks.call('setLockView',{
  "panLock": [true/false/'toggle'],
  "zoomLock": [true/false/'toggle'],
  "boundingBox": [true/false/'toggle'],
  "viewbox": [true/false/'toggle'],
  "editViewbox": [true/false/'toggle']
})

Each of the options (panLock, zoomLock, etc) are optional, and can be set to true to enable them, false to disable them and 'toggle' to toggle them between enabled and disabled.

For example, to disable panLock and toggle zoomLock:

Hooks.call('setLockView',{
  "panLock": false,
  "zoomLock": 'toggle'
})