API Panel.LinkBar.SetStartAdjustment

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Sets the clipping adjustments for the beginning of the link

Class hierarchy

Panel

LinkBar
SetStartAdjustment

Parameters

HANDLE LinkBar

The handle to the bar to adjust the position of

ULONG Adjustment

The automatic adjustment mode for the start position
Typical values for this parameter:
Name Description
Adjust_None 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 The point will meet the bounding box of the sphere

FLOAT Offset

Positive to move the start point towards the center of the link


Return value

This call does not return a value


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