Jump to content

Component: Control Knob (Controls): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,393 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(13 intermediate revisions by 2 users not shown)
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ControlKnob.fcfx FC_Comp_Source_ControlKnob.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ControlKnob.fcfx FC_Comp_Source_ControlKnob.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ControlKnob.fcfx FC_Comp_Source_ControlKnob.fcfx]


==Detailed description==
==Detailed description==




Line 32: Line 42:


==Examples==
==Examples==




Line 45: Line 63:




==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;" | '''GetValue'''
|-
| colspan="2" | Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| 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;" | '''SetValue'''
|-
| colspan="2" | Set the pointer to the given value on the scale.  Returns the angle required to point at the given value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | The value on the scale to move the pointer to. 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| 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;" | Range
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Minimum
|-
| colspan="2" | The minimum value that the knob will output (fully counter_clockwise) 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Maximum
|-
| colspan="2" | The maximum value that the knob will output (fully clockwise) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Startup State
|-
| colspan="2" | Sets the initial value when loading the project or when the runtime starts. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Default Value
|-
| colspan="2" | The default value used on initialise or runtime start. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Title
|-
| colspan="2" | Decides if the component title is shown 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Title Colour
|-
| colspan="2" | Title Label Color 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title Text
|-
| colspan="2" | Title Label Text 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Scale
|-
| colspan="2" | Controls the size of the title text on the panel, default 1.2 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Offset
|-
| colspan="2" | Distance above component center to draw the title 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" | Decides if a label is shown detailing current setting of the control knob. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Label Colour
|-
| colspan="2" | Sets the label colour 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label Units
|-
| colspan="2" | Adds a unit to the end of the label 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Label Decimal Points
|-
| colspan="2" | Number of decinal points to draw on the label 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Scale
|-
| colspan="2" | Sets the size of the label on the panel, default 1.0 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Offset
|-
| colspan="2" | Distance above component center to draw the label 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numeric Labels
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Decimals
|-
| colspan="2" | How many decimal places to show on the number labels. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Text Size %
|-
| colspan="2" | Height of the number label text. 
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Font for the number labels. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Divisions
|-
| colspan="2" | Number of labelled positions around the knob. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Subdivisions
|-
| colspan="2" | Number of divisions between the numbered ones. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | BG Color
|-
| colspan="2" | Background colour behind the knob labelling - may be transparent. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Positive Color
|-
| colspan="2" | Colour for number labels which are less than zero. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Negative Color
|-
| colspan="2" | Colour for number labels which are greater than zero. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Pointer Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Buttons
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Buttons
|-
| colspan="2" | Controls if the adjustment buttons are shown on the scale arc or not. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Button Color
|-
| colspan="2" | Color for the component label text. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Adjustment Value
|-
| colspan="2" | Sets the button adjustment value, will round the value to the nearest whole adjustment. For example with an adjustment of 1,0 the adjustment buttons will jump to the next whole number. 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
==Macro reference==
 
===GetValue===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
| width="90%" class="mtx-class-macrohead" | '''GetValue'''
|-
|-
| colspan="2" | Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode. 
| colspan="2" | Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode. 
Line 261: Line 89:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetValue===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
| width="90%" class="mtx-class-macrohead" | '''SetValue'''
|-
|-
| colspan="2" | Set the pointer to the given value on the scale.  Returns the angle required to point at the given value. 
| colspan="2" | Set the pointer to the given value on the scale.  Returns the angle required to point at the given value. 
Line 277: Line 106:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range
| width="90%" class="mtx-class-propfolder" | Range
|-
|-
|-
|-
Line 313: Line 140:
| colspan="2" | The default value used on initialise or runtime start. 
| colspan="2" | The default value used on initialise or runtime start. 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
| width="90%" class="mtx-class-propfolder" | Title
|-
|-
|-
|-
Line 342: Line 169:
| colspan="2" | Distance above component center to draw the title 
| colspan="2" | Distance above component center to draw the title 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 376: Line 203:
| colspan="2" | Distance above component center to draw the label 
| colspan="2" | Distance above component center to draw the label 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numeric Labels
| width="90%" class="mtx-class-propfolder" | Numeric Labels
|-
|-
|-
|-
Line 405: Line 232:
| colspan="2" | Number of divisions between the numbered ones. 
| colspan="2" | Number of divisions between the numbered ones. 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
| width="90%" class="mtx-class-propfolder" | Scheme
|-
|-
|-
|-
Line 429: Line 256:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Buttons
| width="90%" class="mtx-class-propfolder" | Buttons
|-
|-
|-
|-

Latest revision as of 14:37, 13 July 2026

Author Matrix Ltd
Version 1.3
Category Controls


Control Knob component

Rotary control designed for SCADA. Has customisable value markings around the control. Simulation only.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_ControlKnob.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_ControlKnob.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetValue

GetValue
Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode. 
- FLOAT Return


SetValue

SetValue
Set the pointer to the given value on the scale. Returns the angle required to point at the given value. 
- FLOAT Value
The value on the scale to move the pointer to. 
- FLOAT Return


Property reference

Properties
Range
Minimum
The minimum value that the knob will output (fully counter_clockwise) 
Maximum
The maximum value that the knob will output (fully clockwise) 
Startup State
Sets the initial value when loading the project or when the runtime starts. 
Default Value
The default value used on initialise or runtime start. 
Title
Show Title
Decides if the component title is shown 
Title Colour
Title Label Color 
Title Text
Title Label Text 
Title Scale
Controls the size of the title text on the panel, default 1.2 
Title Offset
Distance above component center to draw the title 
Label
Show Label
Decides if a label is shown detailing current setting of the control knob. 
Label Colour
Sets the label colour 
Label Units
Adds a unit to the end of the label 
Label Decimal Points
Number of decinal points to draw on the label 
Label Scale
Sets the size of the label on the panel, default 1.0 
Label Offset
Distance above component center to draw the label 
Numeric Labels
Decimals
How many decimal places to show on the number labels. 
Text Size %
Height of the number label text. 
Font
Font for the number labels. 
Divisions
Number of labelled positions around the knob. 
Subdivisions
Number of divisions between the numbered ones. 
Scheme
BG Color
Background colour behind the knob labelling - may be transparent. 
Positive Color
Colour for number labels which are less than zero. 
Negative Color
Colour for number labels which are greater than zero. 
Pointer Colour
 
Buttons
Show Buttons
Controls if the adjustment buttons are shown on the scale arc or not. 
Button Color
Color for the component label text. 
Adjustment Value
Sets the button adjustment value, will round the value to the nearest whole adjustment. For example with an adjustment of 1,0 the adjustment buttons will jump to the next whole number. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Control_Knob_(Controls)&oldid=48126"