Component: Scale Arc Template (Advanced Shapes)

From Flowcode Help
Jump to navigationJump to search
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 Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

GetValue

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


SetLabel

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


SetRange

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


SetValue

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-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.