UCI Layer Controller
Use the UCI Layer Controller to show or hide individual layers in a specified UCI and page.
Configuration Overview
- Drag the UCI Layer Controller component into your schematic.
- Select the component and configure its Properties. See Properties.
- Press F5 to save your design to the Core and run it. (Or, press F6 to emulate your design.)
- In your schematic, double-click the component to open its control panel.
- For each UCI layer, configure a Transition type. See Controls.
- Click a layer's Show button to show or hide the layer in the UCI.
Inputs and Outputs
Inputs and Outputs
Control components do not have traditional input and output pins. If a Control Pin is available for the component, an input or output will appear.
Control Pins represent the controls available in the component's Control Panel. Control Pins are used to link controls between Schematic Elements, and link to / from Control Scripts. Control Pin signal pins are represented by a 
square, and the wiring is represented by a thick blue / white line.
Schematic Example
In this example, there are three UCI layers installed. Any of these layers can be transitioned on or off the screen by choosing the Transition type.
Properties
UCI Layer Controller Properties
UCI
Select a UCI name.
Page
If Is Shared is set to 'No':
Select a page name to control the visibility of layers within that page.
Is Shared
Select 'No' to control the visibility of standard layers in a selected Page.
Select 'Yes' to control the visibility of Shared Layers in the selected UCI name.
For information about adding layers to a UCI, see User Control Interface (UCI) Design Overview.
Graphic Properties
Label
Use the Label property to change the name of the component in the schematic. The Label property defaults to the component name. To learn more about renaming schematic elements, see Organizing Your Design.
Position
The coordinates reference a specific place in the schematic - for example,"100,100" (horizontal, vertical). 0,0 is the upper left corner of the schematic.
Fill
Sets the fill color of the component in the schematic.
Script Access Properties
Code Name
Displays the currently assign name for control access. You can use the auto-assigned name or customize it. Q-SYS will automatically check all Code Names in the design to ensure name is unique.
Script Access
Defines whether the component will be accessible by script and/or externally, or not at all. Choices include All, External, None (default), and Script.
- None (default) - Not accessible by any script, plugin, or by Q-SYS Remote Control Protocol (QRC).
- Script - Can be accessed by scripts, such as Text Controller, Block Controllers, and plugins only.
- External - Can only be accessed by 3rd party controls systems using component commands from the Q-SYS Remote Control Protocol (QRC).
- All - No restrictions, can be accessed by 3rd party control systems via Q-SYS Remote Control Protocol (QRC), or script objects or plugin objects.
Tip: Use Script Programmer Mode to quickly view the Script Access setting directly on the component in the design schematic without the need to disconnect from the Q-SYS Core processor.
Controls
Transition (combo box)
Assign a transition type for the layer name.
Show (button)
Click the button to show or hide the layer.
Control Pins
|
Pin Name |
Value |
String |
Position |
Pins Available |
|---|---|---|---|---|
|
layer name: Transition |
N/A |
left right top bottom fade none |
N/A |
Input / Output |
|
layer name: Visibility |
0 1 |
false true |
– |
Input / Output |
