Difference between revisions of "Component: Dial control (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_dial.fcfx FC_Comp_Source_dial.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_dial.fcfx FC_Comp_Source_dial.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_dial.fcfx FC_Comp_Source_dial.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 46: | Line 48: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 72: | Line 76: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| 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;" | '''GetPos''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the position of the pointer | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetTarget''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the target of change messages Send 0 as the target ID to disable | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Target | ||
| + | |- | ||
| + | | colspan="2" | The target component to recieve the message | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | MessageId | ||
| + | |- | ||
| + | | colspan="2" | The identifier of the message to send to | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetAngles''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Start | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | End | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetPos''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the position of the dial, bounded to the pre-set range | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Position | ||
| + | |- | ||
| + | | colspan="2" | The position of the dial in the Users specified range | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Notify | ||
| + | |- | ||
| + | | colspan="2" | Set to true to notify owner Target of a change | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetMarks''' | ||
| + | |- | ||
| + | | colspan="2" | Decides on the presentation of the dial | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Marks | ||
| + | |- | ||
| + | | colspan="2" | Number of marks on the dial | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Subs | ||
| + | |- | ||
| + | | colspan="2" | Number of marks before a 'main' mark - can be zero | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | ShowNumbers | ||
| + | |- | ||
| + | | colspan="2" | True to show numbers on the dial, else false | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetRange''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the min-max range to draw on the dial Used for setting the needle | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Start | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | End | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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" | Sets the label to draw in the center of the dial | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Hi | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Lo | ||
| + | |- | ||
| + | | colspan="2" | Label to draw at the bottom | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 10:01, 27 January 2023
| Author | |
| Version | 1.1 |
| Category | Misc |
Contents
Dial control component
Dial output control
Component Source Code
Please click here to download the component source project: FC_Comp_Source_dial.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_dial.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
GetPos |
| Gets the position of the pointer | |
 - FLOAT
|
Return |
|
|
SetTarget |
| Sets the target of change messages Send 0 as the target ID to disable | |
 - HANDLE
|
Target |
| The target component to recieve the message | |
 - ULONG
|
MessageId |
| The identifier of the message to send to | |
 - VOID
|
Return |
|
|
SetAngles |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
 - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetPos |
| Sets the position of the dial, bounded to the pre-set range | |
| - FLOAT
|
Position |
| The position of the dial in the Users specified range | |
 - BOOL
|
Notify |
| Set to true to notify owner Target of a change | |
| - VOID
|
Return |
|
|
SetMarks |
| Decides on the presentation of the dial | |
| - INT
|
Marks |
| Number of marks on the dial | |
| - INT
|
Subs |
| Number of marks before a 'main' mark - can be zero | |
| - BOOL
|
ShowNumbers |
| True to show numbers on the dial, else false | |
| - VOID
|
Return |
|
|
SetRange |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetLabel |
| Sets the label to draw in the center of the dial | |
 - STRING
|
Hi |
| - STRING
|
Lo |
| Label to draw at the bottom | |
| - VOID
|
Return |
Property reference
|
Properties |
==Macro reference==
|
|
GetPos |
| Gets the position of the pointer | |
| - FLOAT
|
Return |
|
|
SetTarget |
| Sets the target of change messages Send 0 as the target ID to disable | |
| - HANDLE
|
Target |
| The target component to recieve the message | |
| - ULONG
|
MessageId |
| The identifier of the message to send to | |
| - VOID
|
Return |
|
|
SetAngles |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetPos |
| Sets the position of the dial, bounded to the pre-set range | |
| - FLOAT
|
Position |
| The position of the dial in the Users specified range | |
| - BOOL
|
Notify |
| Set to true to notify owner Target of a change | |
| - VOID
|
Return |
|
|
SetMarks |
| Decides on the presentation of the dial | |
| - INT
|
Marks |
| Number of marks on the dial | |
| - INT
|
Subs |
| Number of marks before a 'main' mark - can be zero | |
| - BOOL
|
ShowNumbers |
| True to show numbers on the dial, else false | |
| - VOID
|
Return |
|
|
SetRange |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetLabel |
| Sets the label to draw in the center of the dial | |
| - STRING
|
Hi |
| - STRING
|
Lo |
| Label to draw at the bottom | |
| - VOID
|
Return |
Property reference
|
|
Properties |
==Macro reference==
|
|
GetPos |
| Gets the position of the pointer | |
| - FLOAT
|
Return |
|
|
SetTarget |
| Sets the target of change messages Send 0 as the target ID to disable | |
| - HANDLE
|
Target |
| The target component to recieve the message | |
| - ULONG
|
MessageId |
| The identifier of the message to send to | |
| - VOID
|
Return |
|
|
SetAngles |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetPos |
| Sets the position of the dial, bounded to the pre-set range | |
| - FLOAT
|
Position |
| The position of the dial in the Users specified range | |
| - BOOL
|
Notify |
| Set to true to notify owner Target of a change | |
| - VOID
|
Return |
|
|
SetMarks |
| Decides on the presentation of the dial | |
| - INT
|
Marks |
| Number of marks on the dial | |
| - INT
|
Subs |
| Number of marks before a 'main' mark - can be zero | |
| - BOOL
|
ShowNumbers |
| True to show numbers on the dial, else false | |
| - VOID
|
Return |
|
|
SetRange |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetLabel |
| Sets the label to draw in the center of the dial | |
| - STRING
|
Hi |
| - STRING
|
Lo |
| Label to draw at the bottom | |
| - VOID
|
Return |
Property reference
|
|
Properties |
==Macro reference==
|
|
GetPos |
| Gets the position of the pointer | |
| - FLOAT
|
Return |
|
|
SetTarget |
| Sets the target of change messages Send 0 as the target ID to disable | |
| - HANDLE
|
Target |
| The target component to recieve the message | |
| - ULONG
|
MessageId |
| The identifier of the message to send to | |
| - VOID
|
Return |
|
|
SetAngles |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetPos |
| Sets the position of the dial, bounded to the pre-set range | |
| - FLOAT
|
Position |
| The position of the dial in the Users specified range | |
| - BOOL
|
Notify |
| Set to true to notify owner Target of a change | |
| - VOID
|
Return |
|
|
SetMarks |
| Decides on the presentation of the dial | |
| - INT
|
Marks |
| Number of marks on the dial | |
| - INT
|
Subs |
| Number of marks before a 'main' mark - can be zero | |
| - BOOL
|
ShowNumbers |
| True to show numbers on the dial, else false | |
| - VOID
|
Return |
|
|
SetRange |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| - INT
|
Start |
| - INT
|
End |
| - VOID
|
Return |
|
|
SetLabel |
| Sets the label to draw in the center of the dial | |
| - STRING
|
Hi |
| - STRING
|
Lo |
| Label to draw at the bottom | |
| - VOID
|
Return |
Property reference
|
|
Properties |
