Difference between revisions of "Component: Simulation LED Template (Indicators)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_LED_Sim_Base.fcfx FC_Comp_Source_LED_Sim_Base.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Sim_Base.fcfx FC_Comp_Source_LED_Sim_Base.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Sim_Base.fcfx FC_Comp_Source_LED_Sim_Base.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 44: | Line 50: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOn''' | ||
| + | |- | ||
| + | | colspan="2" | Turn the LED off. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOff''' | ||
| + | |- | ||
| + | | colspan="2" | Turn the LED off. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | ||
| + | | width="90%" | Target Object | ||
| + | |- | ||
| + | | colspan="2" | Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Label | ||
| + | |- | ||
| + | | colspan="2" | Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | On Color | ||
| + | |- | ||
| + | | colspan="2" | The color of the LED when it is turned on. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Off Color | ||
| + | |- | ||
| + | | colspan="2" | The color of the LED when it is turned off. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Auto Off Color | ||
| + | |- | ||
| + | | colspan="2" | When this is selected, the off color is automatically set to a reduced intensity version of the on color. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Startup State | ||
| + | |- | ||
| + | | colspan="2" | Default state of the indicator when loading the project or starting the simulation runtime. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:23, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.4 |
| Category | Indicators |
Contents
Simulation LED Template component
Base for creating simulation LEDs and other on/off visual indicators. Choose a 'Target Object' that will change colour when the pin changes; if multiple objects must change color, group them, and target the group. When 'Auto off color" is selected, changing the 'on color' will automatically choose an off color by reducing the intensity of the on color.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_LED_Sim_Base.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_LED_Sim_Base.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
TurnOn |
| Turn the LED off. | |
 - VOID
|
Return |
|
|
TurnOff |
| Turn the LED off. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Simulation |
|
Target Object |
| Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group. | |
|
Label |
| Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) | |
|
On Color |
| The color of the LED when it is turned on. | |
|
|
Off Color |
| The color of the LED when it is turned off. | |
|
Auto Off Color |
| When this is selected, the off color is automatically set to a reduced intensity version of the on color. | |
|
|
Startup State |
| Default state of the indicator when loading the project or starting the simulation runtime. | |
==Macro reference==
|
|
TurnOn |
| Turn the LED off. | |
| - VOID
|
Return |
|
|
TurnOff |
| Turn the LED off. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Simulation |
|
|
Target Object |
| Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group. | |
|
|
Label |
| Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) | |
|
|
On Color |
| The color of the LED when it is turned on. | |
|
|
Off Color |
| The color of the LED when it is turned off. | |
|
|
Auto Off Color |
| When this is selected, the off color is automatically set to a reduced intensity version of the on color. | |
|
|
Startup State |
| Default state of the indicator when loading the project or starting the simulation runtime. | |
==Macro reference==
|
|
TurnOn |
| Turn the LED off. | |
| - VOID
|
Return |
|
|
TurnOff |
| Turn the LED off. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Simulation |
|
|
Target Object |
| Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group. | |
|
|
Label |
| Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) | |
|
|
On Color |
| The color of the LED when it is turned on. | |
|
|
Off Color |
| The color of the LED when it is turned off. | |
|
|
Auto Off Color |
| When this is selected, the off color is automatically set to a reduced intensity version of the on color. | |
|
|
Startup State |
| Default state of the indicator when loading the project or starting the simulation runtime. | |
