Component: Control Knob (Controls): Difference between revisions

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.

@@ Line 15: / Line 15: @@
 Rotary control designed for SCADA. Has customisable value markings around the control. Simulation only.
-==Component Pack==
+==Component Source Code==
-SCADA
+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]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
@@ Line 29: / Line 63: @@
-==Downloadable 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.&nbsp;
@@ Line 44: / 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.&nbsp;
@@ Line 60: / Line 106: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
+|-
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-propfolder" | Range
 |-
 |-
@@ Line 91: / Line 139: @@
 |-
 | colspan="2" | The default value used on initialise or runtime start.&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Title
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
@@ Line 116: / Line 168: @@
 |-
 | colspan="2" | Distance above component center to draw the title&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Label
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
@@ Line 146: / Line 202: @@
 |-
 | colspan="2" | Distance above component center to draw the label&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Numeric Labels
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
@@ Line 171: / Line 231: @@
 |-
 | colspan="2" | Number of divisions between the numbered ones.&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Scheme
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
@@ Line 191: / Line 255: @@
 |-
 | colspan="2" | &nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Buttons
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
@@ Line 206: / Line 274: @@
 |-
 | 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.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
-|-
 |}

SteveT (talk | contribs)