Viz Artist User Guide

Version 3.13 | Published March 28, 2019 ©

Create and Run Scripts

This section contains two script examples:

  • Example I: This example shows how to write a simple script that controls the alpha value of an object

  • Example II: This example shows how to write a simple script that scales the x-scaling value of a container, based on x-scaling value of another container.

Example I

Start with a simple event-driven script.

  1. Add a Sphere to a Container.

  2. Add a Material and some light.

  3. Create a script object.

    1. Drag the built-in Script plug-in from the Container Plug-insGlobal folder onto a Container.

    2. Click on the Script plug-in icon in a Container

    3. Copy and paste the code, below, into the Script Editor.

      Sub OnEnter()
      Alpha.Value = 100.0
      End Sub
      Sub OnLeave()
      Alpha.Value = 50.0
      End Sub

      This script consists of two event procedures, OnEnter and OnLeave, which are recognized by the system and invoked whenever the mouse cursor enters or leaves the area occupied by the container in the output window. Take a closer look at what happens inside OnEnter:

      Alpha.Value = 100.0

      This code sets the alpha value of the container to 100 (the maximum value). If there is no Alpha object, no action occurs, so make sure that the container has an alpha object by adding the Alpha plug-in. Alpha refers to the container’s alpha object, Value is a member (in this case: the only member) of the alpha object, representing its value. Changes made to Alpha.Value are immediately made visible in the output window.
      Similarly, the code in the body of OnLeave sets the alpha value back to 50.

  4. Add the Alpha plug-in to the container.

  5. Execute the script, click images/download/attachments/50614513/gettingstarted-scripting_compile_icon.png .

  6. Click Edit to return to editing mode if required. To interact with the scene click the images/download/attachments/50614513/workbench_button_e.png button (Scene Editor Buttons) in the Scene Editor.

Note: The images/download/attachments/50614513/workbench_button_e.png button offers a good way for designers to test touch based interaction points added to a scene. The script is then the logic which triggers what happens next (i.e. events).


Example II

This example defines the event procedure OnExecPerField, which is called for each field. The functions and amount of code used in this procedure needs to be decided upon with great consideration. Include only the code that requires execution on a per-field basis, to keep the resulting performance impact as low as possible.


Sub OnExecPerField()
Dim cube As Container
cube = Scene.FindContainer(“Circle”)
If scaling.x > 1.5 Then
cube.Scaling.x = 2.0
cube.Scaling.x = 1.0
End If
End Sub

In the first line, a variable named cube, of type Container, is defined:

Dim cube As Container

Variables of type Container can be initialized to point to a container in the scene tree. In the next line, we call the built-in function FindContainer (which is a member of the scene class, accessible via the container’s Scene property) to initialize cube to point to a container named cube. If there is no such container, cube is set to Null, the consequence being that any further operations on cube have no effect.

cube = Scene.FindContainer(“Cube”)

Now, we check if the x-scaling of the current container (that is, the container holding the script) is greater than 1.5, and, depending on the result, we set the x-scaling of the container named cube to 2.0 or 1.0:

If Scaling.x > 1.5 Then
cube.Scaling.x = 2.0
cube.Scaling.x = 1.0
End If

Note: The expression Scaling.x refers to the current container while cube.Scaling.x refers to the container referenced by the variable cube.