Documentation Center

Viz Artist

Version 3.10 | Published May 03, 2018 ©

MtTelestrator plug-in

images/download/attachments/27789413/viz_icons_multitouchtelestrator.png
The MtTelestrator plug-in is used to do telestration on a Container level (used with the GraffitiTex plug-in (added automatically to the same Container)).

For scene-wide telestration the MtSensor plug-in has a telestration feature.

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

This section contains information on the following topics:

MtTelestrator Configuration

images/download/attachments/27789413/plugins_container_mttelestratorwindow.png

  • Active: Select On (enable) or Off (disable) telestration input from the user.

  • Minimum Telestration Width: Minimum brush width to assign based on pressure applied to sensor.

  • Maximum Telestration Width: Maximum brush width to assign based on pressure applied to sensor.

  • Color: The color to assign for subsequent telestration drawing.

  • Id: To give additional context in the handler script, specify a string that will identify 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: If ON enables shared memory to be updated for the plug-in notifications.

    • 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: Click either Global, Scene, or Distributed. This selects the shared memory area to update.

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

  • Init: Clear current telestration and make Telestration active.

  • Clear: Clear the contents of the attached telestration.

Events and Notifications

The events dispatched by MtTelestrator are:

  • OnTelestrationStateChange (sent when telestration is activated or deactivated):

    • plug-inContainer as String

    • Id as String

    • TelestrationOn as Boolean

  • OnTelestrationColorChange (sent when telestration is activated or deactivated):

    • plug-inContainer as String

    • Id as String

    • PenColor as Color

  • OnTelestrationClear (sent when telestration is cleared):

    • plug-inContainer as String

    • Id as String

    • TelestrationOn as Boolean
      The shared memory field names are:

  • plug-inContainer: the name of the plug-ins container or ‘’ if attached to a scene

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

  • PenColor: the current pen color

  • Active: 1 if telestration is active, 0 if not

The Data Pool structure updated is:

  • MtTelestrator:

    • string plug-inContainer

    • string Id

    • string PenColor

    • string Active

To Create a Simple Scene with Telestration

Note: If a touch screen is not available, see the section Configuring Viz of the Viz Engine Administrator’s Guide and set Multi Touch input to Mouse

  1. Create a new Scene.

  2. Add a new group Container.

  3. Add a Rectangle Geometry to the Container.

  4. Add the MtTelestrator plug-in to the container. This automatically adds the GraffitiTex plug-in to the container.

  5. Set the Active parameter for the MtTelestrator and GraffitiTex to ON in the Properties Panel.

  6. Open the Scene in On Air. Use the touch input device to create freehand drawing.

  7. Use the MtTelestrator and GraffitiTex plug-in editors to modify the telestration affect as required.

See Also