Difference between revisions of "Component: Control Knob (Controls)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.3 (Release)
+
| 1.3
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Controls
 
| Controls
 
|}
 
|}
  
  
 +
==Control Knob component==
 +
Rotary control designed for SCADA. Has customisable value markings around the control. Simulation only.
  
−
==[[File:Component Icon 1f50402b_cc0b_468c_a329_5108c448e263.png|Image]] Control Knob component==
+
==Component Pack==
−
Rotary control designed for SCADA.
 
−
Has customisable value markings around the control.
 
−
Simulation only.
 
  
−
==Examples==
+
SCADA
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
''This component does not contain any downloadable macros''
+
==Examples==
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
−
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.
 
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:''This macro has no parameters''
+
{| 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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:[[Variable Types|FLOAT]]
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
+
| colspan="2" | Set the pointer to the given value on the scale.  Returns the angle required to point at the given value.&nbsp;
−
Set the pointer to the given value on the scale.  Returns the angle required to point at the given value.
+
|-
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
 
+
| width="90%" | Value
−
:[[Variable Types|FLOAT]] ''Value''
+
|-
−
::The value on the scale to move the pointer to.
+
| colspan="2" | The value on the scale to move the pointer to.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
−
'''Return value'''
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
:[[Variable Types|FLOAT]]
 
  
  
Line 62: Line 65:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Minimum</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_min''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
The minimum value that the knob will output (fully counter_clockwise)
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Maximum</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_max''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minimum
−
The maximum value that the knob will output (fully clockwise)
+
|-
−
 
+
| colspan="2" | The minimum value that the knob will output (fully counter_clockwise)&nbsp;
−
<span style="font-weight: normal;"><u>Startup State</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''StartupState''.
+
| width="90%" | Maximum
−
 
+
|-
−
Sets the initial value when loading the project or when the runtime starts.
+
| colspan="2" | The maximum value that the knob will output (fully clockwise)&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Default Value</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Startup State
−
This property is of type ''Floating point'' and can be referenced with the variable name ''DefaultValue''.
+
|-
−
 
+
| colspan="2" | Sets the initial value when loading the project or when the runtime starts.&nbsp;
−
The default value used on initialise or runtime start.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Show Title</u></span>
+
| width="90%" | Default Value
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.
+
| colspan="2" | The default value used on initialise or runtime start.&nbsp;
−
 
+
|-
−
Decides if the component title is shown
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show Title
−
<span style="font-weight: normal;"><u>Title Colour</u></span>
+
|-
−
 
+
| colspan="2" | Decides if the component title is shown&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
Title Label Color
+
| width="90%" | Title Colour
−
 
+
|-
−
<span style="font-weight: normal;"><u>Title Text</u></span>
+
| colspan="2" | Title Label Color&nbsp;
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Title Text
−
Title Label Text
+
|-
−
 
+
| colspan="2" | Title Label Text&nbsp;
−
<span style="font-weight: normal;"><u>Title Scale</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.
+
| width="90%" | Title Scale
−
 
+
|-
−
Controls the size of the title text on the panel, default 1.2
+
| colspan="2" | Controls the size of the title text on the panel, default 1.2&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show Label</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Title Offset
−
This property is of type ''True or false'' and can be referenced with the variable name ''ShowLabel''.
+
|-
−
 
+
| colspan="2" | Distance above component center to draw the title&nbsp;
−
Decides if a label is shown detailing current setting of the control knob.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Label Colour</u></span>
+
| width="90%" | Show Label
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''LabelColour''.
+
| colspan="2" | Decides if a label is shown detailing current setting of the control knob.&nbsp;
−
 
+
|-
−
Sets the label colour
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Label Colour
−
<span style="font-weight: normal;"><u>Label Units</u></span>
+
|-
−
 
+
| colspan="2" | Sets the label colour&nbsp;
−
This property is of type ''Line of text'' and can be referenced with the variable name ''LabelUnits''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
Adds a unit to the end of the label
+
| width="90%" | Label Units
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Decimal Points</u></span>
+
| colspan="2" | Adds a unit to the end of the label&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LabelDecPoints''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Label Decimal Points
−
Number of decinal points to draw on the label
+
|-
−
 
+
| colspan="2" | Number of decinal points to draw on the label&nbsp;
−
<span style="font-weight: normal;"><u>Label Scale</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''LabelScale''.
+
| width="90%" | Label Scale
−
 
+
|-
−
Sets the size of the label on the panel, default 1.0
+
| colspan="2" | Sets the size of the label on the panel, default 1.0&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Decimals</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Label Offset
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
+
|-
−
 
+
| colspan="2" | Distance above component center to draw the label&nbsp;
−
How many decimal places to show on the number labels.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
| width="90%" | Decimals
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
+
| colspan="2" | How many decimal places to show on the number labels.&nbsp;
−
 
+
|-
−
Height of the number label text.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Text Size %
−
<span style="font-weight: normal;"><u>Font</u></span>
+
|-
−
 
+
| colspan="2" | Height of the number label text.&nbsp;
−
This property is of type ''Font picker'' and can be referenced with the variable name ''num_font''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
Font for the number labels.
+
| width="90%" | Font
−
 
+
|-
−
<span style="font-weight: normal;"><u>Divisions</u></span>
+
| colspan="2" | Font for the number labels.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_count''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Divisions
−
Number of labelled positions around the knob.
+
|-
−
 
+
| colspan="2" | Number of labelled positions around the knob.&nbsp;
−
<span style="font-weight: normal;"><u>Subdivisions</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_subdiv''.
+
| width="90%" | Subdivisions
−
 
+
|-
−
Number of divisions between the numbered ones.
+
| colspan="2" | Number of divisions between the numbered ones.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>BG Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | BG Color
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
+
|-
−
 
+
| colspan="2" | Background colour behind the knob labelling - may be transparent.&nbsp;
−
Background colour behind the knob labelling - may be transparent.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
<span style="font-weight: normal;"><u>Positive Color</u></span>
+
| width="90%" | Positive Color
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
+
| colspan="2" | Colour for number labels which are less than zero.&nbsp;
−
 
+
|-
−
Colour for number labels which are less than zero.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Negative Color
−
<span style="font-weight: normal;"><u>Negative Color</u></span>
+
|-
−
 
+
| colspan="2" | Colour for number labels which are greater than zero.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''neg_color''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
Colour for number labels which are greater than zero.
+
| width="90%" | Pointer Colour
−
 
+
|-
−
<span style="font-weight: normal;"><u>Pointer Colour</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''NeedleColor''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show Buttons
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | Controls if the adjustment buttons are shown on the scale arc or not.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
<span style="font-weight: normal;"><u>Show Buttons</u></span>
+
| width="90%" | Button Color
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''scale_arc::ShowButtons''.
+
| colspan="2" | Color for the component label text.&nbsp;
−
 
+
|-
−
Controls if the adjustment buttons are shown on the scale arc or not.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Adjustment Value
−
<span style="font-weight: normal;"><u>Button Color</u></span>
+
|-
−
 
+
| 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;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''scale_arc::label_color''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
Color for the component label text.
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
−
 
+
|-
−
<span style="font-weight: normal;"><u>Adjustment Value</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''scale_arc::ButtonAdjustment''.
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
−
 
+
|-
−
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.
 

Revision as of 16:22, 7 January 2022

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 Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png SetValue
Set the pointer to the given value on the scale. Returns the angle required to point at the given value. 
Fc9-f32-icon.png - FLOAT Value
The value on the scale to move the pointer to. 
Fc9-f32-icon.png - FLOAT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Minimum
The minimum value that the knob will output (fully counter_clockwise) 
Fc9-type-15-icon.png Maximum
The maximum value that the knob will output (fully clockwise) 
Fc9-type-16-icon.png Startup State
Sets the initial value when loading the project or when the runtime starts. 
Fc9-type-15-icon.png Default Value
The default value used on initialise or runtime start. 
Fc9-type-7-icon.png Show Title
Decides if the component title is shown 
Fc9-type-1-icon.png Title Colour
Title Label Color 
Fc9-type-10-icon.png Title Text
Title Label Text 
Fc9-type-15-icon.png Title Scale
Controls the size of the title text on the panel, default 1.2 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-type-7-icon.png Show Label
Decides if a label is shown detailing current setting of the control knob. 
Fc9-type-1-icon.png Label Colour
Sets the label colour 
Fc9-type-10-icon.png Label Units
Adds a unit to the end of the label 
Fc9-type-21-icon.png Label Decimal Points
Number of decinal points to draw on the label 
Fc9-type-15-icon.png Label Scale
Sets the size of the label on the panel, default 1.0 
Fc9-type-15-icon.png Label Offset
Distance above component center to draw the label 
Fc9-type-14-icon.png Decimals
How many decimal places to show on the number labels. 
Fc9-type-14-icon.png Text Size %
Height of the number label text. 
Fc9-type-3-icon.png Font
Font for the number labels. 
Fc9-type-14-icon.png Divisions
Number of labelled positions around the knob. 
Fc9-type-14-icon.png Subdivisions
Number of divisions between the numbered ones. 
Fc9-type-2-icon.png BG Color
Background colour behind the knob labelling - may be transparent. 
Fc9-type-1-icon.png Positive Color
Colour for number labels which are less than zero. 
Fc9-type-1-icon.png Negative Color
Colour for number labels which are greater than zero. 
Fc9-type-1-icon.png Pointer Colour
 
Fc9-type-7-icon.png Show Buttons
Controls if the adjustment buttons are shown on the scale arc or not. 
Fc9-type-1-icon.png Button Color
Color for the component label text. 
Fc9-type-15-icon.png 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. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Control_Knob_(Controls)&oldid=27721"