Difference between revisions of "API Panel.LinkBar.SetEndAdjustment"
From Flowcode Help
Jump to navigationJump to search (XML import of LinkBar API) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| 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;" | '''SetEndAdjustment''' | |
| − | + | |- | |
| − | + | | colspan="2" | Sets the clipping adjustments for the end of the link | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | :: | + | | width="90%" | LinkBar |
| − | + | |- | |
| − | + | | colspan="2" | The handle to the bar to adjust the position of | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG |
| − | [[ | + | | width="90%" | Adjustment |
| − | |||
| − | |||
| − | [[ | ||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | colspan="2" | The automatic adjustment mode for the end position | |
| − | |||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | | | + | | width="90%" | Offset |
|- | |- | ||
| − | | | + | | colspan="2" | Positive to move the end point towards the center of the link |
| − | | | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE |
| − | | | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
|} | |} | ||
| − | |||
| − | |||
| + | ==Detailed description== | ||
| + | This causes the link end to clip to an offset from the center of the end position. | ||
| + | |||
| + | |||
| + | The ''Adjustment'' is the clipping mode for the end of the link. This is the position the link will end when considering the bounding box of the end position. The default is ''Adjust_Box''. ''Adjust_Sphere'' will assume a spherical area around the position, and ''Adjust_None'' will end the link at the center of the position. All modes may be adjusted by ''Offset''. | ||
| + | |||
| + | [[File:SIMAPI Panel.LinkBar.AdjustEnd Modes.svg|none|thumb|Clipping modes|300px]] | ||
| − | |||
| − | |||
| + | The ''Offset'' is always a positive value to reduce the length of the link. That is, ''Offset'' is from the end position in the direction of the start position. Specifying 10 units will reduce the link length by 10 world units. | ||
| − | |||
| − | |||
| Line 49: | Line 43: | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetEndAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetEndAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
SetEndAdjustment |
| Sets the clipping adjustments for the end of the link | |
 - HANDLE
|
LinkBar |
| The handle to the bar to adjust the position of | |
 - ULONG
|
Adjustment |
| The automatic adjustment mode for the end position | |
 - FLOAT
|
Offset |
| Positive to move the end point towards the center of the link | |
 - NONE
|
Return |
Detailed description
This causes the link end to clip to an offset from the center of the end position.
The Adjustment is the clipping mode for the end of the link. This is the position the link will end when considering the bounding box of the end position. The default is Adjust_Box. Adjust_Sphere will assume a spherical area around the position, and Adjust_None will end the link at the center of the position. All modes may be adjusted by Offset.
The Offset is always a positive value to reduce the length of the link. That is, Offset is from the end position in the direction of the start position. Specifying 10 units will reduce the link length by 10 world units.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.LinkBar.SetEndAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)
