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

Revision as of 11:53, 3 February 2023

Author	Matrix Ltd
Version	1.1
Category	Misc

Marking control component

A control to draw markings on any component

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

DrawStripY

	DrawStripY
Draw the marks on the readout Set up the position and range with SetRange() and SetSpan()
- INT	OffsetX
Offset to add to X
- VOID	Return

SetTarget

	SetTarget
Sets the target image to draw on
- ULONG	Target

- INT	AreaX
The X area to draw on
- INT	AreaY
The Y area to draw on
- BOOL	AutoCreate
Set true to auto-create the graphic
- VOID	Return

DrawStripX

	DrawStripX
Draw the marks on the readout Set up the position and range with SetRange() and SetSpan()
- INT	OffsetY
Offset to add to Y
- VOID	Return

BoundRange

	BoundRange
Bounds a range to be between RangeStart and RangeEnd
- FLOAT	Range
The unbounded range
- FLOAT	Return

DrawArc

	DrawArc
Draw the marks on the readout Set up the position and range with SetRange() and SetArc()
- FLOAT	Radius
Scale of the radius to draw at
- VOID	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

SetShow

	SetShow
Decides on the presentation of the dial
- BOOL	ShowNumbers
True to show numbers on the dial, else false
- BOOL	ShowMarks
Show marks
- VOID	Return

CalcScaleRange

	CalcScaleRange
Decide the range value for a 0->1 value Returned value may be out of range
- FLOAT	ScaledRange

- FLOAT	Return

CalcAngRange

	CalcAngRange
Decide the range value for an angle Returned value may be out of range
- FLOAT	AngleDegrees

- FLOAT	Return

CalcScale

	CalcScale
Decide the scale (0->1) to display at given a range value
- FLOAT	RangeVal

- FLOAT	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
- VOID	Return

ClearArea

	ClearArea
Clears the draw area
- 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

SetGaps

	SetGaps
Sets the min-max of the span to draw on the X/Y marks Defaults are 0 and 1
- INT	Start

- INT	End

- VOID	Return

SetJustify

	SetJustify

- BOOL	RAlign
True for right/top/outer alignment
- VOID	Return

CalcAngle

	CalcAngle
Decide the angle to display at given a range value
- FLOAT	RangeVal

- FLOAT	Return

Property reference

	Properties

@@ Line 73: / Line 73: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 79: / Line 81: @@
 ==Macro reference==
+===DrawStripY===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 97: / Line 100: @@
+===SetTarget===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 130: / Line 134: @@
+===DrawStripX===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 148: / Line 153: @@
+===BoundRange===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 166: / Line 172: @@
+===DrawArc===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 184: / Line 191: @@
+===SetAngles===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 207: / Line 215: @@
+===SetShow===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 230: / Line 239: @@
+===CalcScaleRange===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 248: / Line 258: @@
+===CalcAngRange===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 266: / Line 277: @@
+===CalcScale===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 284: / Line 296: @@
+===SetMarks===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 307: / Line 320: @@
+===ClearArea===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 320: / Line 334: @@
+===SetRange===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 343: / Line 358: @@
+===SetGaps===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 366: / Line 382: @@
+===SetJustify===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 384: / Line 401: @@
+===CalcAngle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-