Difference between revisions of "API Panel.LinkBar.SetStartAdjustment"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets the clipping adjustments for the beginning of the link
 
 
 
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Panel|Panel]]
 
:[[API Panel.LinkBar|LinkBar]]
 
::[[API Panel.LinkBar|SetStartAdjustment]]
 
</div>
 
__TOC__
 
 
 
==Parameters==
 
[[Variable Types|HANDLE]] ''LinkBar''
 
:The handle to the bar to adjust the position of
 
 
 
[[Variable Types|ULONG]] ''Adjustment''
 
:The automatic adjustment mode for the start position
 
:''Typical values for this parameter:''
 
::{| class="wikitable" width="65%"
 
 
|-
 
|-
! width="30%" |Name
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
! width="55%" |Description
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartAdjustment'''
 
|-
 
|-
|Adjust_None
+
| colspan="2" | Sets the clipping adjustments for the beginning of the link&nbsp;
|The point will meet the center of the target position
 
 
|-
 
|-
|Adjust_Sphere
 
|The point will meet the edge of the sphere encompassing the position
 
 
|-
 
|-
|Adjust_Box
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
|The point will meet the bounding box of the sphere
+
| width="90%" | LinkBar
 +
|-
 +
| colspan="2" | The handle to the bar to adjust the position of&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Adjustment
 +
|-
 +
| colspan="2" | The automatic adjustment mode for the start position&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Offset
 +
|-
 +
| colspan="2" | Positive to move the start point towards the center of the link&nbsp;
 +
|-
 +
| 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''
 
|}
 
|}
 
[[Variable Types|FLOAT]] ''Offset''
 
:Positive to move the start point towards the center of the link
 
 
 
==Return value==
 
''This call does not return a value''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png SetStartAdjustment
Sets the clipping adjustments for the beginning of the link 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to adjust the position of 
Fc9-u32-icon.png - ULONG Adjustment
The automatic adjustment mode for the start position 
Fc9-f32-icon.png - FLOAT Offset
Positive to move the start point towards the center of the link 
Fc9-void-icon.png - NONE Return


Detailed description

This causes the link start to clip to an offset from the center of the start position.


The Adjustment is the clipping mode for the start of the link. This is the position the link will start when considering the bounding box of the start 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.

Clipping modes


The Offset is always a positive value to reduce the length of the link. That is, Offset is from the start position in the direction of the end 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.SetStartAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)

No additional examples