API Panel.LinkBar.SetStartAdjustment: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetStartAdjustment
Sets the clipping adjustments for the beginning of the link
- HANDLE	LinkBar
The handle to the bar to adjust the position of
- ULONG	Adjustment
The automatic adjustment mode for the start position
- FLOAT	Offset
Positive to move the start point towards the center of the link
- 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.

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)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API Contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Sets the clipping adjustments for the beginning of the link
+| width="90%" class="mtx-class-macrohead" | '''SetStartAdjustment'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sets the clipping adjustments for the beginning of the link&nbsp;
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+|-
-:[[API Panel.LinkBar|LinkBar]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Panel.LinkBar|SetStartAdjustment]]
+| width="90%" | LinkBar
-</div>
+|-
-__TOC__
+| colspan="2" | The handle to the bar to adjust the position of&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|HANDLE]] ''LinkBar''
+| width="90%" | Adjustment
-: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
+| colspan="2" | The automatic adjustment mode for the start position&nbsp;
-! width="55%" |Description
 |-
-|Adjust_None
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-|The point will meet the center of the target position
+| width="90%" | Offset
 |-
-|Adjust_Sphere
+| colspan="2" | Positive to move the start point towards the center of the link&nbsp;
-|The point will meet the edge of the sphere encompassing the position
 |-
-|Adjust_Box
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-|The point will meet the bounding box of the sphere
+| 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''
@@ Line 58: / Line 43: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation