API Panel.LinkBar.SetStartAdjustment - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:56Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:29Z

JonnyW: XML import

2014-01-16T15:57:51Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:33Z

XML import of API documentation

JonnyW at 13:30, 1 July 2013

2013-07-01T13:30:21Z

JonnyW: XML import of LinkBar API

2013-07-01T10:46:11Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
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="55%" |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
|}

[[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''

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===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>''

← Older revision		Revision as of 11:54, 16 January 2023
Line 43:		Line 43:
	===Calling in a calculation===		===Calling in a calculation===
	* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartAdjustment(linkbar, ::Panel.LinkBar.Adjust_None, offset)</pre>		* 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>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-! 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;
 |-
 |-
-|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
 |}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Sets the clipping adjustments for the beginning of the link		Sets the clipping adjustments for the beginning of the link

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Sets the clipping adjustments for the beginning of the link		Sets the clipping adjustments for the beginning of the link

← Older revision		Revision as of 13:30, 1 July 2013
Line 43:		Line 43:

	==Detailed description==		==Detailed description==
−	''~~<span style="color~~:~~red;">No additional information</span>~~''	+	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''.
		+
		+	[[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 start position in the direction of the end position. Specifying 10 units will reduce the link length by 10 world units.
		+