API Panel.LinkBar.GetBarPos - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:57Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:30Z

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 15:40, 1 July 2013

2013-07-01T15:40:56Z

JonnyW: XML import of LinkBar API

2013-07-01T10:46:12Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
Gets the position the bar is located at

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Panel|Panel]]
:[[API Panel.LinkBar|LinkBar]]
::[[API Panel.LinkBar|GetBarPos]]
</div>
__TOC__

==Parameters==
[[Variable Types|HANDLE]] ''LinkBar''
:The handle to the bar to read

==Return value==
[[Variable Types|HANDLE]]

Returns the position the bar is located at

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

==Examples==
===Calling in a calculation===
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetBarPos(linkbar)</pre>

''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 11:54, 16 January 2023
Line 39:		Line 39:
	* Declare a variable 'result' of type HANDLE		* Declare a variable 'result' of type HANDLE
	* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetBarPos(linkbar)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.LinkBar.GetBarPos(linkbar)</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;"
-Gets the position the bar is located at
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBarPos'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Gets the position the bar is located at&nbsp;
-:[[API Panel.LinkBar|LinkBar]]
+|-
-::[[API Panel.LinkBar|GetBarPos]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | LinkBar
+|-
-==Parameters==
+| colspan="2" | The handle to the bar to read&nbsp;
-[[Variable Types|HANDLE]] ''LinkBar''
+|-
-:The handle to the bar to read
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Gets the position the bar is located at		Gets the position the bar is located at

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


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Gets the position the bar is located at		Gets the position the bar is located at

← Older revision		Revision as of 15:40, 1 July 2013
Line 24:		Line 24:

	==Detailed description==		==Detailed description==
−	~~''<span style="color~~:~~red;">No additional information</span>''~~	+	[[File:SIMAPI_Panel.LinkBar.GetBarPos Orientation.svg\|thumb\|250px\|Orientation of the bar position]]
		+
		+	Gets the scale, orientation and center point of the link bar. The position is always specified in world coordinates.
		+
		+
		+	The X and Y scales will equal the width specified by [[API Panel.LinkBar.SetBarGfx]]. The Z scale is half the distance between the start and end points of the link. All values are always positive.
		+
		+
		+	The coordinates of the position are always located in the center of the link. Therefore the distance from the coordinates of the bar position to either the start or end is equal to the scale Z.
		+
		+
		+	For the rotation of the position, the only axis that may be accurately relied on is the Z. Rotation around this axis is undefined so the X and Y axis of the position may vary, as these can not be reliably extracted from the start or end positions with 100% reliability.
		+
		+	In the diagram, the blue line representing Z will always point from the start towards the end position. If the start positions coordinates are equal to the end position, and the previous orientation will be used, which will be the world orientation if the link is created with a shared start and end position.
		+