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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Steve Tandy
 
| Steve Tandy
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 0.1 (Development)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Controls
 
| Controls
 
|}
 
|}
  
  
 +
==Circular Knob component==
 +
A circular 2d knob component.
  
−
==[[File:Component Icon a11aa47b_7c82_4dad_b62d_b1a263e2a4fe.png|Image]] Circular Knob component==
+
==Component Pack==
−
A circular 2d knob component.
 
  
−
==Examples==
+
FREE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
 
−
Returns the current value of the component.
 
  
−
'''Parameters'''
+
''No detailed description exists yet for this component''
  
−
:''This macro has no parameters''
+
==Examples==
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
+
A basic App Developer example using two Circular knobs to simulate data e.g., temperature.
−
Sets the component to the specified value.
+
Both xy chart and Console, log the data.
  
−
'''Parameters'''
+
{{Fcfile|Logging_Example.fcsx|Logging Example}}
  
−
:[[Variable Types|FLOAT]] ''value''
+
==Downloadable macro reference==
−
::A new value for the component.
 
  
 +
{| 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" | Returns the current value of the component.&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'''
 
  
−
:''This call does not return a value''
+
{| 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" | Sets the component to the specified value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | value
 +
|-
 +
| colspan="2" | A new value for the component.&nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
Line 58: Line 74:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Value</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::Base2dObject::dValue''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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>Style</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Value
−
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nStyle''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
−
 
+
|-
−
<span style="font-weight: normal;"><u>Pointer</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
This property is of type ''Fixed list of text'' and can be referenced with the variable name ''nKnobPointer''.
+
| width="90%" | Style
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
 
+
| width="90%" | Pointer
−
<span style="font-weight: normal;"><u>Discrete Values</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''bDiscrete''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Discrete Values
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Background Colour</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | Background Colour
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''colBackgroundColour''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range
−
 
+
|-
−
<span style="font-weight: normal;"><u>Lower Bound</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 ''Base2dGauge::dLowerBound''.
+
| width="90%" | Lower Bound
−
 
+
|-
−
The bottom value of the scale.
+
| colspan="2" | The bottom value of the scale.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Upper Bound</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Upper Bound
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dUpperBound''.
+
|-
−
 
+
| colspan="2" | The top value of the scale.&nbsp;
−
The top value of the scale.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>Major Tick Step</u></span>
+
| width="90%" | Major Tick Step
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Base2dGauge::dMajorTickStep''.
+
| colspan="2" | The number of minor tick marks to show a major tick mark value.&nbsp;
−
 
+
|-
−
The number of minor tick marks to show a major tick mark value.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minor Tick Step
−
<span style="font-weight: normal;"><u>Minor Tick Step</u></span>
+
|-
−
 
+
| colspan="2" | The scale value between consecutive minor tick marks.&nbsp;
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Base2dGauge::dMinorTickStep''.
+
|}
−
 
 
−
The scale value between consecutive minor tick marks.
 

Latest revision as of 17:19, 9 November 2022

Author Steve Tandy
Version 1.0
Category Controls


Circular Knob component

A circular 2d knob component.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

A basic App Developer example using two Circular knobs to simulate data e.g., temperature. Both xy chart and Console, log the data.

FC6 Icon.png Logging Example

Downloadable macro reference

Fc9-comp-macro.png GetValue
Returns the current value of the component. 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
Fc9-f32-icon.png - FLOAT value
A new value for the component. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Value
 
Fc9-conn-icon.png Appearance
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Pointer
 
Fc9-type-7-icon.png Discrete Values
 
Fc9-type-2-icon.png Background Colour
 
Fc9-conn-icon.png Range
Fc9-type-15-icon.png Lower Bound
The bottom value of the scale. 
Fc9-type-15-icon.png Upper Bound
The top value of the scale. 
Fc9-type-21-icon.png Major Tick Step
The number of minor tick marks to show a major tick mark value. 
Fc9-type-15-icon.png Minor Tick Step
The scale value between consecutive minor tick marks. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Circular_Knob_(Controls)&oldid=28486"