Encoder

Navigation:  Widget Designer > Widgets > Fader Controls >

Encoder

prev main next

Navigation:  Widget Designer > Widgets > Fader Controls >

Encoder

prev main next

Loading...

An Encoder can be created to control Pandoras Box device parameters or a sequence opacity, additionally you can retrieve and set its value with nodes and Object and Member Notation.

wd_widget_fader_encoder

To create an Encoder widget choose "Widgets > Faders > Encoder". The mouse cursor changes to a crosshairs icon, indicating the create mode. Each left-click adds the selected widget to the current page. To quit the create mode, you can switch to the run mode with [F8], where you can use all widgets. Most widgets however need to be set up first.

To edit the Encoder properties simply right-click it and choose the first menu entry "Encoder Properties". Alternatively, you can press [Alt + P] whilst the mouse is hovering above it or switch to the edit / move mode with [F9] and double-click on it. The Encoder property dialog opens up.

wd_widget_fader_encoder-properties

General Widget Settings

Name:

A unique name can be entered to identify the widget via the Object and Member Notation. The default name is based on the widget type and ID.

Page:

This drop-down offers all available pages to place the widget on.

ID:
The Encoder's ID may be changed by entering a new one in the text field top left. If you change it, you will be asked if you also want to adapt the name to the new ID.

Notes:

A short note can be added here. It is not displayed outside the widget but can be set and retrieved with the WidgetID.Note property member.

Visible:

Uncheck this box to hide the widget.

Fix:
When the option "Fix" is checked, the Encoder will be displayed on every page.

Size:

Enter a pixel size for the Encoder's size.

X and Y:

Enter the location of the widget (upper left corner) in pixels

Encoder Style

Two images can be assigned to the different parts of the Encoder, "Handle" and "Background".

 

Click on the "..." button to open a file dialog where you can choose your path and image. If you would like to choose an image from the Widget Designer "library", click on the "Res" button. The Resource Manager opens where you can double-click on the image of your choice. You can also save custom images in the Resource Manager to access them faster. The small "x" at the right sets the default image.

 

Encoder Control

Seq:
Check this box to directly control the opacity of a Sequence and enter the respective sequence ID.

Invert:

Check this box to invert your value.

Devices:
Check the box on the right to send the Encoder value to a Device (layer) parameter. Enter the Site and Device ID of the respective Device, multiple Devices can be entered too, with a white space as separator (e.g.: "2.1 2.2 2.17")

Parameter:

This drop-down offers you all available Device parameters of Pandoras Box. If you want to access an FX parameter, use the FX name and the pipe symbol to specify it (e.g.: "RGB Multiply|Blue"). If the parameter list does not show the desired parameter (in case that you use a custom device) simply type in the name of the parameter here.

Minimum / Maximum:
Enter here the minimum and maximum value your Encoder should have, as well as the Default position of the handle.

Factor:

Enter here a factor with which the step size should be multiplied. If you set a factor of 7, each movement of the Encoder will increase/decrease the value by 7 instead of 1.

Throttle:

The Throttle parameter limits the amount of data transmitted to Pandoras Box. The higher this value is, the fewer times the Device's parameters are updated. Throttling the data can help saving performance, but also reduces smoothness.

Mouse Wheel Input:

If you check this box, the Encoder will react to your mouse's scroll wheel when hovering over the widget.

Group Values

This option is only available for the Unlimited version and offers the possibility to assign a group. Please refer to the chapter Group Values for more information.

Network Broadcasting

The NBS (Network Broadcast Service) allows to transmit and update Faders, Labels and Custom Script Buttons across multiple WD Designers instances on the network. To activate this service, please refer to the Remoting Menu!

Enable Send:
To send the Encoder values as broadcast into the network, you only have to check "Enable Send".

Enable Receive:
To receive values from other Encoders, please check "Enable Receive".

Now you have to specify which item should update your Encoder:

Enter the IP address of the computer you want to listen to. This could be the local computer (to control the Encoder through another item on the same Widget Designer) or a different computer in the network. If you do not want to specify the computer but want to listen to all computers in the network, enter "255.255.255.255".

As next step specify the item you want to take the values from. This could e.g. be "Encoder1" or "Encoder2".

Once all values are set, the Encoder is ready to be used or edited at any time.

Midi I/O

The Encoder widget is able to receive Midi Notes and / or send its own value as Midi note velocity. A Midi input / output device has to be connected via the Connection Manager or the Midi Connection Manager.

For sending and receiving Midi, please select which one you would like to do and enter the respective settings:

Device:

If you have several connected Midi devices, enter here the ID of a specific device assigned in the Midi Connection Manager.

Status / Channel / Note:

Specify the values of the note you want to listen to or send. The values are numeric, so note E4 would be represented by 64. Please note that different translations of Midi notes can exist for different devices, so you might need to add or subtract an octave.

7/15bit:

Some systems support 15 bit Midi values instead of 7bit, select the respective radio box here.

Ui Effects & Animations

The topic Effects & Animations explains how to add and apply CSS based effects and animations.