Difference between revisions of "Component: Scale Arc Template (Advanced Shapes)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(3 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
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Advanced Shapes
 
| Advanced Shapes
 
|}
 
|}
  
  
 +
==Scale Arc Template component==
 +
A base component for drawing circular dials.  This allows a simple way to create graduated and labelled dials, for example, within meter and rotary control components. Mouse handling is built in for ease of building interactive controls.
  
−
==[[File:Component Icon f307403b_2134_4efa_bfac_bbd0adc0f253.png|Image]] Scale Arc Template component==
+
==Component Pack==
−
A base component for drawing circular dials.  This allows a simple way to create graduated
 
−
and labelled dials, for example, within meter and rotary control components.
 
−
Mouse handling is built in for ease of building interactive controls.
 
  
 +
MODELS
  
−
This component can be used as a base to create ''child'' components
+
==Detailed description==
  
−
The following components all inherit the traits of Scale Arc Template:
 
  
−
{| class="wikitable" width="50%"
+
 
−
|+|-
+
''No detailed description exists yet for this component''
−
|[[File:Component Icon 2e0aa52e_ac04_4997_b3ac_77205ba19522.png|Image]] Dashboard Knob
 
−
|Rotary control designed for the dashboard panel.  Has customisable value markings
 
−
around the control.  Simulation only - the control value can be read using simulation macros
 
−
but is not connected to a chip pin.
 
−
|-
 
−
|[[File:Component Icon 8c84170a_6fe8_4386_9709_451a0d21da64.png|Image]] Dashboard Meter
 
−
|Simulation only round meter/dial.  The range of values displayed is easily adjusted.
 
−
|}
 
  
 
==Examples==
 
==Examples==
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
+
''<span style="color:red;">No additional examples</span>''
  
−
==Simulation macro reference==
+
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
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"
+
|-
 +
| 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''
 +
|}
  
−
mode.
 
  
−
'''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;" | '''SetValue'''
 +
|-
 +
| colspan="2" | Set the pointer to the given value on the scale.  Returns the angle required to point at the given value.&nbsp;
 +
|-
 +
|-
 +
| 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.&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''
 +
|}
  
−
:''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;" | '''SetLabel'''
 +
|-
 +
| colspan="2" | Set the label text for the scale&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Label
 +
|-
 +
| colspan="2" | Text to display.as the component label.&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''
 +
|}
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRange'''
−
Set the pointer to the given value on the scale.  Returns the angle required to point at the given value.
+
|-
−
 
+
| colspan="2" | Set the minimum and maximum values of the scale&nbsp;
−
'''Parameters'''
+
|-
−
 
+
|-
−
:[[Variable Types|FLOAT]] ''Value''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
::The value on the scale to move the pointer to.
+
| width="90%" | Minimum
−
 
+
|-
−
 
+
| colspan="2" | Minimum value for the scale&nbsp;
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
:[[Variable Types|FLOAT]]
+
| width="90%" | Maximum
−
 
+
|-
−
 
+
| colspan="2" | Maximum value for the scale&nbsp;
−
===<span style="font-weight: normal;"><u><tt>SetLabel</tt></u></span>===
+
|-
−
Set the label text for the scale
+
| 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''
−
'''Parameters'''
+
|}
−
 
 
−
:[[Variable Types|STRING]] ''Label''
 
−
::Text to display.as the component label.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetRange</tt></u></span>===
 
−
Set the minimum and maximum values of the scale
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Minimum''
 
−
::Minimum value for the scale
 
−
 
 
−
:[[Variable Types|FLOAT]] ''Maximum''
 
−
::Maximum value for the scale
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
  
  
Line 109: Line 108:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Pointer</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''target_object''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Set another panel object to be a pointer that will rotate around the scale.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Depending on the property 'Function' (below)....
+
|-
−
 
+
|-
−
"Display" mode - the object acts as a pointer showing the values set by the "SetValue" macro.
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
 
+
| width="90%" | Pointer
−
"Control" mode - the object acts as a handle for mouse movements that will set the current value.
+
|-
−
 
+
| colspan="2" | Set another panel object to be a pointer that will rotate around the scale. Depending on the property 'Function' (below).... "Display" mode - the object acts as a pointer showing the values set by the "SetValue" macro. "Control" mode - the object acts as a handle for mouse movements that will set the current value.&nbsp;
−
<span style="font-weight: normal;"><u>Axis Object</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
This property is of type ''Panel object'' and can be referenced with the variable name ''axis_object''.
+
| width="90%" | Axis Object
−
 
+
|-
−
An object to act as the centre of the arc, and rotation point of the 'Pointer' object.
+
| colspan="2" | An object to act as the centre of the arc, and rotation point of the 'Pointer' object. By default, the arc is drawn centrally, but by assigning an object here, the whole scale can be centred around a different point.&nbsp;
−
 
+
|-
−
By default, the arc is drawn centrally, but by assigning an object here, the whole scale can be centred
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Function
−
around a different point.
+
|-
−
 
+
| colspan="2" | Choose the 'mode' of the component. "Display" mode - the arc can act as a value display, with the 'Pointer' object rotating to show incoming value changes. "Control" mode - clicking on the scale, or 'Pointer' object, sets the value directly, which can be susequently read by the "GetValue" macro.&nbsp;
−
<span style="font-weight: normal;"><u>Function</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''is_control''.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
−
 
+
|-
−
Choose the 'mode' of the component.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
"Display" mode - the arc can act as a value display, with the 'Pointer' object rotating to show incoming
+
| width="90%" | Canvas Shape
−
 
+
|-
−
value changes.
+
| colspan="2" | Shape of the plane on which to draw the scale. &nbsp;
−
 
+
|-
−
"Control" mode - clicking on the scale, or 'Pointer' object, sets the value directly, which can be
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Resolution
−
susequently read by the "GetValue" macro.
+
|-
−
 
+
| colspan="2" | The number of pixels per world unit of size. The scale is drawn as a bit-map, so this setting determines the level of detail vs. drawing speed and memory usage.&nbsp;
−
<span style="font-weight: normal;"><u>Canvas Shape</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''canvas_shape''.
+
| width="90%" | BG Color
−
 
+
|-
−
Shape of the plane on which to draw the scale.
+
| colspan="2" | Color of the scale background.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Resolution</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Positive Color
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''resolution''.
+
|-
−
 
+
| colspan="2" | Color for arc and divisions for negative values.&nbsp;
−
The number of pixels per world unit of size.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
The scale is drawn as a bit-map, so this setting determines the level of detail vs. drawing speed and memory
+
| width="90%" | Negative Color
−
 
+
|-
−
usage.
+
| colspan="2" | Color for the arc and divisions for positive values.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>BG Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Label Color
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
+
|-
−
 
+
| colspan="2" | Color for the component label text.&nbsp;
−
Color of the scale background.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Positive Color</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Arc
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Color for arc and divisions for negative values.
+
| width="90%" | Radius %
−
 
+
|-
−
<span style="font-weight: normal;"><u>Negative Color</u></span>
+
| colspan="2" | Radius of the arc line as a percentage of the component's shortest dimension.&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-14-icon.png]]
−
 
+
| width="90%" | Start Angle
−
Color for the arc and divisions for positive values.
+
|-
−
 
+
| colspan="2" | Start angle of the sweep, where the minimum value will appear. Measured in degrees, anti-clockwise from the positive X-axis.&nbsp;
−
<span style="font-weight: normal;"><u>Label Color</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Color picker'' and can be referenced with the variable name ''label_color''.
+
| width="90%" | Sweep
−
 
+
|-
−
Color for the component label text.
+
| colspan="2" | The number of degrees between the minimum value and the maximum value.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Radius %</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Thickness
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''arc_radius''.
+
|-
−
 
+
| colspan="2" | Thickness of the arc line.&nbsp;
−
Radius of the arc line as a percentage of the component's shortest dimension.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Start Angle</u></span>
+
| width="90%" | Show
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''arc_start''.
+
| colspan="2" | Whether to show or hide the arc.&nbsp;
−
 
+
|-
−
Start angle of the sweep, where the minimum value will appear.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Marks
−
Measured in degrees, anti-clockwise from the positive X-axis.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Sweep</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Divisions
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''arc_sweep''.
+
|-
−
 
+
| colspan="2" | Number of main divisions around the scale - these divisions can be numbered.&nbsp;
−
The number of degrees between the minimum value and the maximum value.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Thickness</u></span>
+
| width="90%" | Radius %
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''arc_thick''.
+
| colspan="2" | Radius of the division ends - they are drawn from here to their intersection with the arc. % of the component size.&nbsp;
−
 
+
|-
−
Thickness of the arc line.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Thickness
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| colspan="2" | Thickness of main (numbered) division lines.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_arc''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Whether to show or hide the arc.
+
| width="90%" | Subdivisions
−
 
+
|-
−
<span style="font-weight: normal;"><u>Divisions</u></span>
+
| colspan="2" | Number of smaller divisions between each main division.  Set to zero if not required.&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%" | Subs Radius %
−
Number of main divisions around the scale - these divisions can be numbered.
+
|-
−
 
+
| colspan="2" | Radius of the small division ends.  They are drawn from here to their intersection with the arc. % of component size.&nbsp;
−
<span style="font-weight: normal;"><u>Radius %</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_radius''.
+
| width="90%" | Subs Thickness
−
 
+
|-
−
Radius of the division ends - they are drawn from here to their intersection with the arc.
+
| colspan="2" | Thickness of sub-division lines.&nbsp;
−
 
+
|-
−
% of the component size.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show
−
<span style="font-weight: normal;"><u>Thickness</u></span>
+
|-
−
 
+
| colspan="2" | Whether to show or hide the division markings.&nbsp;
−
This property is of type ''Floating point'' and can be referenced with the variable name ''divs_thick''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Thickness of main (numbered) division lines.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numbers
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subdivisions</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_subdiv''.
+
| width="90%" | Maximum
−
 
+
|-
−
Number of smaller divisions between each main division.  Set to zero if not required.
+
| colspan="2" | Maximum value to show on the display.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subs Radius %</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minimum
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subdiv_radius''.
+
|-
−
 
+
| colspan="2" | Minimum value to show on the display.&nbsp;
−
Radius of the small division ends.  They are drawn from here to their intersection with the arc.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
% of component size.
+
| width="90%" | Decimals
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subs Thickness</u></span>
+
| colspan="2" | Number of decimal places to show on the number values.&nbsp;
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''subs_thick''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Radius %
−
Thickness of sub-division lines.
+
|-
−
 
+
| colspan="2" | Radius from the centre to place the number values. % of component size.&nbsp;
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_marks''.
+
| width="90%" | Text Size %
−
 
+
|-
−
Whether to show or hide the division markings.
+
| colspan="2" | Height of number text - % of component size.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Maximum</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
 
+
| width="90%" | Font
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_max''.
+
|-
−
 
+
| colspan="2" | Font for the number values.&nbsp;
−
Maximum value to show on the display.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Minimum</u></span>
+
| width="90%" | Show
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_min''.
+
| colspan="2" | Show or hide the number values.&nbsp;
−
 
+
|-
−
Minimum value to show on the display.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
−
<span style="font-weight: normal;"><u>Decimals</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Text
−
Number of decimal places to show on the number values.
+
|-
−
 
+
| colspan="2" | A text label to help identify the display.&nbsp;
−
<span style="font-weight: normal;"><u>Radius %</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 ''num_radius''.
+
| width="90%" | Radius %
−
 
+
|-
−
Radius from the centre to place the number values.
+
| colspan="2" | Radius to place the label - % of component size.&nbsp;
−
 
+
|-
−
% of component size.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Angle
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
|-
−
 
+
| colspan="2" | Angle at which to place the label - degrees anti-clockwise from the positive X-axis.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Height of number text - % of component size.
+
| width="90%" | Text Size %
−
 
+
|-
−
<span style="font-weight: normal;"><u>Font</u></span>
+
| colspan="2" | Height of the label font - % of component size.&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]]
−
 
+
| width="90%" | Font
−
Font for the number values.
+
|-
−
 
+
| colspan="2" | Font for the text label.&nbsp;
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_numbers''.
+
| width="90%" | Show
−
 
+
|-
−
Show or hide the number values.
+
| colspan="2" | Show or hide the text label.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Text</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Buttons
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label_text''.
+
|-
−
 
+
|-
−
A text label to help identify the display.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show Buttons
−
<span style="font-weight: normal;"><u>Radius %</u></span>
+
|-
−
 
+
| colspan="2" | Controls if the adjustment buttons are shown on the scale arc or not.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_radius''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
Radius to place the label - % of component size.
+
| width="90%" | Adjustment Value
−
 
+
|-
−
<span style="font-weight: normal;"><u>Angle</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 ''Signed integer'' and can be referenced with the variable name ''label_angle''.
 
−
 
 
−
Angle at which to place the label - degrees anti-clockwise from the positive X-axis.
 
−
 
 
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
 
−
 
 
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_size''.
 
−
 
 
−
Height of the label font - % of component size.
 
−
 
 
−
<span style="font-weight: normal;"><u>Font</u></span>
 
−
 
 
−
This property is of type ''Font picker'' and can be referenced with the variable name ''label_font''.
 
−
 
 
−
Font for the text label.
 
−
 
 
−
<span style="font-weight: normal;"><u>Show</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_label''.
 
−
 
 
−
Show or hide the text label.
 

Latest revision as of 17:22, 9 November 2022

Author Matrix Ltd
Version 1.2
Category Advanced Shapes


Scale Arc Template component

A base component for drawing circular dials. This allows a simple way to create graduated and labelled dials, for example, within meter and rotary control components. Mouse handling is built in for ease of building interactive controls.

Component Pack

MODELS

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


Fc9-comp-macro.png SetLabel
Set the label text for the scale 
Fc9-string-icon.png - STRING Label
Text to display.as the component label. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetRange
Set the minimum and maximum values of the scale 
Fc9-f32-icon.png - FLOAT Minimum
Minimum value for the scale 
Fc9-f32-icon.png - FLOAT Maximum
Maximum value for the scale 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Pointer
Set another panel object to be a pointer that will rotate around the scale. Depending on the property 'Function' (below).... "Display" mode - the object acts as a pointer showing the values set by the "SetValue" macro. "Control" mode - the object acts as a handle for mouse movements that will set the current value. 
Fc9-type-17-icon.png Axis Object
An object to act as the centre of the arc, and rotation point of the 'Pointer' object. By default, the arc is drawn centrally, but by assigning an object here, the whole scale can be centred around a different point. 
Fc9-type-16-icon.png Function
Choose the 'mode' of the component. "Display" mode - the arc can act as a value display, with the 'Pointer' object rotating to show incoming value changes. "Control" mode - clicking on the scale, or 'Pointer' object, sets the value directly, which can be susequently read by the "GetValue" macro. 
Fc9-conn-icon.png Style
Fc9-type-16-icon.png Canvas Shape
Shape of the plane on which to draw the scale.  
Fc9-type-14-icon.png Resolution
The number of pixels per world unit of size. The scale is drawn as a bit-map, so this setting determines the level of detail vs. drawing speed and memory usage. 
Fc9-type-2-icon.png BG Color
Color of the scale background. 
Fc9-type-1-icon.png Positive Color
Color for arc and divisions for negative values. 
Fc9-type-1-icon.png Negative Color
Color for the arc and divisions for positive values. 
Fc9-type-1-icon.png Label Color
Color for the component label text. 
Fc9-conn-icon.png Arc
Fc9-type-14-icon.png Radius %
Radius of the arc line as a percentage of the component's shortest dimension. 
Fc9-type-14-icon.png Start Angle
Start angle of the sweep, where the minimum value will appear. Measured in degrees, anti-clockwise from the positive X-axis. 
Fc9-type-14-icon.png Sweep
The number of degrees between the minimum value and the maximum value. 
Fc9-type-15-icon.png Thickness
Thickness of the arc line. 
Fc9-type-7-icon.png Show
Whether to show or hide the arc. 
Fc9-conn-icon.png Marks
Fc9-type-14-icon.png Divisions
Number of main divisions around the scale - these divisions can be numbered. 
Fc9-type-14-icon.png Radius %
Radius of the division ends - they are drawn from here to their intersection with the arc. % of the component size. 
Fc9-type-15-icon.png Thickness
Thickness of main (numbered) division lines. 
Fc9-type-14-icon.png Subdivisions
Number of smaller divisions between each main division. Set to zero if not required. 
Fc9-type-14-icon.png Subs Radius %
Radius of the small division ends. They are drawn from here to their intersection with the arc. % of component size. 
Fc9-type-15-icon.png Subs Thickness
Thickness of sub-division lines. 
Fc9-type-7-icon.png Show
Whether to show or hide the division markings. 
Fc9-conn-icon.png Numbers
Fc9-type-15-icon.png Maximum
Maximum value to show on the display. 
Fc9-type-15-icon.png Minimum
Minimum value to show on the display. 
Fc9-type-14-icon.png Decimals
Number of decimal places to show on the number values. 
Fc9-type-14-icon.png Radius %
Radius from the centre to place the number values. % of component size. 
Fc9-type-14-icon.png Text Size %
Height of number text - % of component size. 
Fc9-type-3-icon.png Font
Font for the number values. 
Fc9-type-7-icon.png Show
Show or hide the number values. 
Fc9-conn-icon.png Label
Fc9-type-10-icon.png Text
A text label to help identify the display. 
Fc9-type-14-icon.png Radius %
Radius to place the label - % of component size. 
Fc9-type-14-icon.png Angle
Angle at which to place the label - degrees anti-clockwise from the positive X-axis. 
Fc9-type-14-icon.png Text Size %
Height of the label font - % of component size. 
Fc9-type-3-icon.png Font
Font for the text label. 
Fc9-type-7-icon.png Show
Show or hide the text label. 
Fc9-conn-icon.png Buttons
Fc9-type-7-icon.png Show Buttons
Controls if the adjustment buttons are shown on the scale arc or not. 
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. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Scale_Arc_Template_(Advanced_Shapes)&oldid=28749"