Viz Plug-ins User Guide

Version 5.1 | Published December 12, 2023 ©

MtNavigator

images/download/thumbnails/114312465/ico_mtnav.png
The MtNavigator plug-in controls the Viz World Navigator plug-in.

The MtNavigator plug-in allows MultiTouch free navigation over a map generated by the Curious World Maps plug-ins. Currently it only supports the ‘Flat’ map model, and not the globe or other 3D models. It sends commands to the Navigator plug-in to change the position and distance of the map based on MultiTouch input.

Note: This plug-in is located in: Plugins -> Container plug-ins -> MultiTouchComp

MtNavigator Configuration

  • Georeference Container: Specifies the container which owns the Navigator plug-in.

  • Momentum: Enables movement or rotation with momentum after the object is released.

    • Friction: Sets the amount of friction used when momentum is enabled.

  • Limit Camera Distance: Limits the maximum and minimum camera distance.

  • Is free navigation allowed: Activates or deactivates navigation.

  • Id: Gives additional context in the handler script, specify a string that identifies any notifications dispatched by this plug-in. This is often included as an argument for the event so a common script may handle events from a number of plug-ins.

  • Set Shared Memory: Enables shared memory to be updated for the plug-in notifications when set to On.

    • Shared Memory Prefix: This sets a ‘prefix name’ to be prepended to the shared memory variables maintained by the plug-ins notifications. For plug-ins that maintain multiple fields each field name has the prefix prepended to it followed by a dot (.) so as to mimic member access to an object (i.e. if the prefix is Obj the fields field1 and field2 would be identified with the strings Obj.field1 and Obj.field2. The shared memory field Obj is also maintained and is simply an integer that is modified every time any of its subfields is updated).

    • Shared Memory Type: Selects the shared memory area to update. Click either Global, Scene, or Distributed.

  • Set Data Pool: Shows ‘you wish’ plug-in notifications to set a Data Pool variable.

    • Data Pool Variable: Shows the name of the Data Pool variable to have set.

Events and Notifications

The events dispatched by MtNavigator are:

OnNavGrab (when navigable object is ‘grabbed’):

sub OnNavGrab (HitContainer as String, Id as String, Offset as Vertex, Distance as Double, plug-inContainer as String)

end sub

  • HitContainer as String

  • Id as String

  • Offset as Vertex

  • Distance as Double

  • plug-inContainer as String
    OnNavGrabUpdate (when navigable object is moved):

sub OnNavGrabUpdate (HitContainer as String, Id as String, Offset as Vertex, Distance as Double, plug-inContainer as String)

end sub

  • HitContainer as String

  • Id as String

  • Offset as Vertex

  • Distance as Double

  • plug-inContainer as String

  • OnNavGrabRelease (when navigable object is released):

    • HitContainer as String

    • Id as String

The Shared Memory Field names updated are:

  • HitContainer: The name of the container that was ‘hit’

  • Id: The user ID string entered in the notification interface

  • Offset: The current lon/lat position in the Navigator

  • Distance: The current distance in the Navigator

  • plug-inContainer: The name of the container this plug-in is attached to

  • Active: Set to 1 if ‘grabbed’, 0 if ‘released’

The Data Pool structure updated is:

  • MtNavigator:

    • string Id

    • string HitContainer

    • string Offset

    • string Scale

    • string plug-inContainer

    • string Active

Basic Scene Design

Follow these steps to create a minimal scene which uses the MtNavigator plug-in:

  1. Add to a new container named Nav to a GeoImage plug-in and set:

    1. Set Use Base Map to Off.

    2. Set Map Size to 700.0.

  2. Add the CWMClient plug-in to the container Nav.

  3. Add the Navigator plug-in to the container Nav.

  4. Add MTNavigator to the container Nav and set Nav as Georeference Container.

  5. Add the NavFinder plug-in to the container Nav and select Map-Start as Hop Point.

  6. Add a new container Atlas as child of Nav and add the Atlas plug-in to it.