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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(10 intermediate revisions by 3 users not shown)
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''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===[[API Panel|Panel]]
 
:[[API Panel.Position|Position]]
 
::[[API Panel.Position|GetOrigin]]
 
</div>
 
__TOC__
 
  
==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==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==

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()