Difference between revisions of "API Panel.Position.GetOrigin"

Latest revision as of 11:54, 16 January 2023

	GetOrigin
Gets a handle to an empty position
- HANDLE	Return

This creates and returns a handle representing the world-space origin. That is:

This is useful for building a position from scratch, and may be thought of as an 'empty' position.

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets a handle to an empty position
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetOrigin'''
+|-
+| colspan="2" | Gets a handle to an empty position&nbsp;
+|-
+|-
+| 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''
+|}
-===Parameters===
+==Detailed description==
-''This function has no parameters''
+This creates and returns a handle representing the world-space origin. That is:
+{| width="25%"
+|-
+| Coordinates
+| 0,0,0
+|-
+| Scale
+| 1,1,1
+|-
+|Rotation
+| 0 degrees
+|}
-===Return value===
+This is useful for building a position from scratch, and may be thought of as an 'empty' position.
-[[Variable types|HANDLE]]
-Returns the handle to an empty position
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type HANDLE
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Panel.Position.GetOrigin()</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetOrigin()</pre>