Difference between revisions of "Component: Dial control (Misc)"

Latest revision as of 13:13, 7 February 2023

Author
Version	1.1
Category	Misc

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

	GetPos
Gets the position of the pointer
- FLOAT	Return

SetAngles

	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

SetLabel

	SetLabel
Sets the label to draw in the center of the dial
- STRING	Hi

- STRING	Lo
Label to draw at the bottom
- VOID	Return

SetMarks

	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

SetPos

	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

SetRange

	SetRange
Sets the min-max range to draw on the dial Used for setting the needle
- INT	Start

- INT	End

- VOID	Return

SetTarget

	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

Property reference

	Properties

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_dial.fcfx FC_Comp_Source_dial.fcfx]
+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]
 ==Detailed description==
@@ Line 38: / Line 50: @@
 ==Examples==
@@ Line 57: / Line 79: @@
-==Downloadable macro reference==
+==Macro reference==
+===GetPos===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 72: / Line 105: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetAngles===
-|-
-| 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 &nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-| width="90%" | Target
-|-
-| colspan="2" | The target component to recieve the message&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | MessageId
-|-
-| colspan="2" | The identifier of the message to send to&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''
-|}
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 118: / Line 129: @@
+===SetLabel===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLabel'''
 |-
-| colspan="2" | Sets the position of the dial, bounded to the pre-set range&nbsp;
+| colspan="2" | Sets the label to draw in the center of the dial&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Position
+| width="90%" | Hi
 |-
-| colspan="2" | The position of the dial in the Users specified range&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Notify
+| width="90%" | Lo
 |-
-| colspan="2" | Set to true to notify owner Target of a change&nbsp;
+| colspan="2" | Label to draw at the bottom&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 141: / Line 153: @@
+===SetMarks===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 169: / Line 182: @@
+===SetPos===
+{| 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&nbsp;
+|-
+|-
+| 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&nbsp;
+|-
+| 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&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''
+|}
+===SetRange===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 192: / Line 230: @@
+===SetTarget===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTarget'''
 |-
-| colspan="2" | Sets the label to draw in the center of the dial&nbsp;
+| colspan="2" | Sets the target of change messages Send 0 as the target ID to disable &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-| width="90%" | Hi
+| width="90%" | Target
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | The target component to recieve the message&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Lo
+| width="90%" | MessageId
 |-
-| colspan="2" | Label to draw at the bottom&nbsp;
+| colspan="2" | The identifier of the message to send to&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''
 |}

Difference between revisions of "Component: Dial control (Misc)"

Latest revision as of 13:13, 7 February 2023

Contents