Link Components
Link Component can only be added to the Scene of the Blueprint Actor. this is to compensate for the Control Components that are not allowed to be attached inside the Blueprint Actor.
Link Components by default will be availble in the Global Layer in Erizos Studio, unless a Control Layer is added to the Blueprint, then it will be automatically added to that Layer.
Link Components will automatically be added to a dynamic layer if added to a dynamic layer actor without the need to add a control layer.
Link Clock
The Link Clock component allows users to create clock-related functionalities such as timers and stopwatches. It must be attached to a Text 3D actor to allow the value to be controlled using Erizos Studio.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| Start Time (Seconds) | Number | Specify the Start time of the clock (in Seconds) |
| End Time | Boolean | Specify the End time of the clock (in Seconds) |
| Direction | Up/Down | Turned off by default |
| Format | String | Sets the direction of the clock in which it will increment/decrement. |
| Custom Format | String | Selects the format of the clock to be displayed from a preconfigured set |
| Start on Set | Boolean | Create a custom format of the clock to be displayed |
| Control End Time | Boolean | Start the clock every time it is on the “Set” mode. |
| Control Direction | Boolean | Exposes the Control End time field on Erizos Studio |
Link Color
The Link Color component can be applied to any actor that has a material with a vector parameter. The component allows the user to change the RGB values from Erizos Studio via a Color picker UI component. users also have the option to provide default presets.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| ColorName | String | The name of the Color parameter that will be controlled |
| Presets | Color | Adds a preconfigured set of Colors that can be controlled from Erizos Studio |
Link Component
Link (Link Component) is an attachable component to any actor that lets Erizos Studio modify the visibility and transformation values in real-time.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| Control Visibility | Boolean | Exposes the visibility control of the Actor so it can be controlled from Erizos Studio |
| Control Position X | Boolean | Exposes the X-axis Position property so it can be controlled from Erizos Studio |
| Control Position Y | Boolean | Exposes the Y-axis Position property so it can be controlled from Erizos Studio |
| Control Position Z | Boolean | Exposes the Z-axis Position property so it can be controlled from Erizos Studio |
| Position Minimum | Vector | Sets the Minimum acceptable Position of the controlled actor |
| Position Maximum | Vector | Sets the Maximum acceptable Position of the controlled actor |
| Control Rotation Roll | Boolean | Exposes the Roll rotation property so it can be controlled from Erizos Studio |
| Control Rotation Pitch | Boolean | Exposes the Pitch rotation property so it can be controlled from Erizos Studio |
| Control Rotation Yaw | Boolean | Exposes the Yaw rotation property so it can be controlled from Erizos Studio |
| Rotation Minimum | Vector | Sets the Minimum acceptable Rotation of the controlled actor |
| Rotation Maximum | Vector | Sets the Maximum acceptable Rotation of the controlled actor |
| Control Scale X | Boolean | Exposes the X-axis scale property so it can be controlled from Erizos Studio |
| Control Scale Y | Boolean | Exposes the Y-axis scale property so it can be controlled from Erizos Studio |
| Control Scale Z | Boolean | Exposes the Z-axis scale property so it can be controlled from Erizos Studio |
| Scale Minimum | Vector | Sets the Minimum acceptable Scale of the controlled actor |
| Scale Maximum | Vector | Sets the Maximum acceptable Scale of the controlled actor |
| Event | Description |
|---|---|
| On Visibility Changed | Executes when the Visibility of the Actor Changes |
| On Position Changed | Executes when the Position of the Actor Changes |
| On Rotation Changed | Executes when the Rotation of the Actor Changes |
| On Scale Changed | Executes when the Scale of the Actor Changes |
Link Material Scalar
The Link Material Scalar allows the user to control any material parameter. Unlike Link Texture which only controls a ParameterTexture2D and is displayed as an image picker in Studio and Link Color which controls a vector parameter and is displayed as a Color picker in Studio, the Link Material Scalar can be used to control all other material properties. e.g. expose a float parameter to control opacity property
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| Scalar Name | String | The Scalar parameter reference to be controlled |
Link Number
The Link Number component can be attached to a Text 3D actor to allow the number value to be exposed to and controlled by Erizos Studio.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| Minimum | Number | Sets the minimum range of value allowed in the number input |
| Maximum | Number | Sets the maximum range of value allowed in the number input |
| Thousand Separator | Dropdown/Selectbox | Sets the thousand separator formatting of the number to be displayed |
| Plus Prefix | String | Sets the Prefix if a number is Positive |
| Minus Prefix | String | Sets the Prefix if a number is Negative |
| Suffix | String | Sets the Suffix of the number input |
| Decimal Separator | Dropdown/Selectbox | Sets the decimal separator formatting of the number to be displayed |
| Decimal Places | Number | Sets the number of decimal places to be displayed |
Link Text
The Link Text component can be attached to a Text 3D actor to allow the text value to be exposed to, and controlled by Erizos Studio.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| Max Characters | Number | Set the maximum characters allowed |
| Upper Case | Boolean | If turned on, the text will be rendered in uppercase. |
| Single Line | Boolean | If turned on, the text will be Single line or Multiline (default is set to Single line) |
| Expose Kerning | Boolean | Exposes the setting for Spacing of the text so it can be controlled from Erizos Studio |
| Expose Line Spacing | Boolean | Exposes the setting for Line Spacing of the text so it can be controlled from Erizos Studio |
| Expose Alignment | Boolean | Exposes the setting for Alignment of the text so it can be controlled from Erizos Studio |
Link Texture
The Control Texture component can be added to any actor that has a Material with a ParameterTexture2D property. This component allows Studio to control the texture of the material.
| Property | Type | Description |
|---|---|---|
| ControlID | String | The ID of the control component |
| Title | String | The name of the control that appears in Erizos Studio |
| TextureName | String | The name of the Texture parameter that will be controlled |
| Presets | Textures | Adds a preconfigured set of Textures that can be used in Erizos Studio, this is useful when the textures are known ahead of time. |