Difference between revisions of "Component: Marking control (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_markings.fcfx FC_Comp_Source_markings.fcfx] |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 38: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 58: | Line 62: | ||
==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;" | '''DrawStripY''' | ||
| + | |- | ||
| + | | colspan="2" | Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | OffsetX | ||
| + | |- | ||
| + | | colspan="2" | Offset to add to X | ||
| + | |- | ||
| + | | 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;" | '''SetTarget''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the target image to draw on | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Target | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | AreaX | ||
| + | |- | ||
| + | | colspan="2" | The X area to draw on | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | AreaY | ||
| + | |- | ||
| + | | colspan="2" | The Y area to draw on | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | AutoCreate | ||
| + | |- | ||
| + | | colspan="2" | Set true to auto-create the graphic | ||
| + | |- | ||
| + | | 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;" | '''DrawStripX''' | ||
| + | |- | ||
| + | | colspan="2" | Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | OffsetY | ||
| + | |- | ||
| + | | colspan="2" | Offset to add to Y | ||
| + | |- | ||
| + | | 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;" | '''BoundRange''' | ||
| + | |- | ||
| + | | colspan="2" | Bounds a range to be between RangeStart and RangeEnd | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Range | ||
| + | |- | ||
| + | | colspan="2" | The unbounded range | ||
| + | |- | ||
| + | | 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;" | '''DrawArc''' | ||
| + | |- | ||
| + | | colspan="2" | Draw the marks on the readout Set up the position and range with SetRange() and SetArc() | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Radius | ||
| + | |- | ||
| + | | colspan="2" | Scale of the radius to draw at | ||
| + | |- | ||
| + | | 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;" | '''SetShow''' | ||
| + | |- | ||
| + | | colspan="2" | Decides on the presentation of the dial | ||
| + | |- | ||
| + | |- | ||
| + | | 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" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | ShowMarks | ||
| + | |- | ||
| + | | colspan="2" | Show marks | ||
| + | |- | ||
| + | | 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;" | '''CalcScaleRange''' | ||
| + | |- | ||
| + | | colspan="2" | Decide the range value for a 0->1 value Returned value may be out of range | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | ScaledRange | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''CalcAngRange''' | ||
| + | |- | ||
| + | | colspan="2" | Decide the range value for an angle Returned value may be out of range | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | AngleDegrees | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''CalcScale''' | ||
| + | |- | ||
| + | | colspan="2" | Decide the scale (0->1) to display at given a range value | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | RangeVal | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''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" 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;" | '''ClearArea''' | ||
| + | |- | ||
| + | | colspan="2" | Clears the draw area | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''SetGaps''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the min-max of the span to draw on the X/Y marks Defaults are 0 and 1 | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''SetJustify''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | RAlign | ||
| + | |- | ||
| + | | colspan="2" | True for right/top/outer alignment | ||
| + | |- | ||
| + | | 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;" | '''CalcAngle''' | ||
| + | |- | ||
| + | | colspan="2" | Decide the angle to display at given a range value | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | RangeVal | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==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 15:18, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Misc |
Contents
Marking control component
A control to draw markings on any component
Component Source Code
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 | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | |
| OffsetX | |
| Offset to add to X | |
| Return | |
| SetTarget | |
| Sets the target image to draw on | |
| Target | |
| AreaX | |
| The X area to draw on | |
| AreaY | |
| The Y area to draw on | |
| AutoCreate | |
| Set true to auto-create the graphic | |
| Return | |
| DrawStripX | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | |
| OffsetY | |
| Offset to add to Y | |
| Return | |
| BoundRange | |
| Bounds a range to be between RangeStart and RangeEnd | |
| Range | |
| The unbounded range | |
| Return | |
| DrawArc | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetArc() | |
| Radius | |
| Scale of the radius to draw at | |
| Return | |
| SetAngles | |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
| Start | |
| End | |
| Return | |
| SetShow | |
| Decides on the presentation of the dial | |
| ShowNumbers | |
| True to show numbers on the dial, else false | |
| ShowMarks | |
| Show marks | |
| Return | |
| CalcScaleRange | |
| Decide the range value for a 0->1 value Returned value may be out of range | |
| ScaledRange | |
| Return | |
| CalcAngRange | |
| Decide the range value for an angle Returned value may be out of range | |
| AngleDegrees | |
| Return | |
| CalcScale | |
| Decide the scale (0->1) to display at given a range value | |
| RangeVal | |
| Return | |
| SetMarks | |
| Decides on the presentation of the dial | |
| Marks | |
| Number of marks on the dial | |
| Subs | |
| Number of marks before a 'main' mark - can be zero | |
| Return | |
| ClearArea | |
| Clears the draw area | |
| Return | |
| SetRange | |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| Start | |
| End | |
| Return | |
| SetGaps | |
| Sets the min-max of the span to draw on the X/Y marks Defaults are 0 and 1 | |
| Start | |
| End | |
| Return | |
| SetJustify | |
| RAlign | |
| True for right/top/outer alignment | |
| Return | |
| CalcAngle | |
| Decide the angle to display at given a range value | |
| RangeVal | |
| Return | |
Property reference
| Properties |
==Macro reference==
| DrawStripY | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | |
| OffsetX | |
| Offset to add to X | |
| Return | |
| SetTarget | |
| Sets the target image to draw on | |
| Target | |
| AreaX | |
| The X area to draw on | |
| AreaY | |
| The Y area to draw on | |
| AutoCreate | |
| Set true to auto-create the graphic | |
| Return | |
| DrawStripX | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetSpan() | |
| OffsetY | |
| Offset to add to Y | |
| Return | |
| BoundRange | |
| Bounds a range to be between RangeStart and RangeEnd | |
| Range | |
| The unbounded range | |
| Return | |
| DrawArc | |
| Draw the marks on the readout Set up the position and range with SetRange() and SetArc() | |
| Radius | |
| Scale of the radius to draw at | |
| Return | |
| SetAngles | |
| Sets the min-max angles to draw on the dial Used for setting the needle Defaults are 135 and -45 | |
| Start | |
| End | |
| Return | |
| SetShow | |
| Decides on the presentation of the dial | |
| ShowNumbers | |
| True to show numbers on the dial, else false | |
| ShowMarks | |
| Show marks | |
| Return | |
| CalcScaleRange | |
| Decide the range value for a 0->1 value Returned value may be out of range | |
| ScaledRange | |
| Return | |
| CalcAngRange | |
| Decide the range value for an angle Returned value may be out of range | |
| AngleDegrees | |
| Return | |
| CalcScale | |
| Decide the scale (0->1) to display at given a range value | |
| RangeVal | |
| Return | |
| SetMarks | |
| Decides on the presentation of the dial | |
| Marks | |
| Number of marks on the dial | |
| Subs | |
| Number of marks before a 'main' mark - can be zero | |
| Return | |
| ClearArea | |
| Clears the draw area | |
| Return | |
| SetRange | |
| Sets the min-max range to draw on the dial Used for setting the needle | |
| Start | |
| End | |
| Return | |
| SetGaps | |
| Sets the min-max of the span to draw on the X/Y marks Defaults are 0 and 1 | |
| Start | |
| End | |
| Return | |
| SetJustify | |
| RAlign | |
| True for right/top/outer alignment | |
| Return | |
| CalcAngle | |
| Decide the angle to display at given a range value | |
| RangeVal | |
| Return | |
Property reference
| Properties |