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

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Gets a handle to an empty position
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetOrigin'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Gets a handle to an empty position&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.Position|Position]]
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.Position|GetOrigin]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
</div>
+
|}
__TOC__
 
 
 
==Parameters==
 
''This function has no parameters''
 
 
 
 
 
==Return value==
 
[[Variable Types|HANDLE]]
 
 
 
Returns the handle to an empty position
 
  
  
Line 43: Line 33:
 
* 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.Position.GetOrigin()</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetOrigin()</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png GetOrigin
Gets a handle to an empty position 
Fc9-h32-icon.png - HANDLE Return


Detailed description

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

Coordinates 0,0,0
Scale 1,1,1
Rotation 0 degrees

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


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.Position.GetOrigin()