Difference between revisions of "API Panel.Position.GetOrigin"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a handle to an empty position | Gets a handle to an empty position | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy=== | + | ====Class hierarchy==== |
| − | + | [[API Panel|Panel]] | |
| − | : | + | :[[API Panel.Position|Position]] |
| − | :: | + | ::[[API Panel.Position|GetOrigin]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
| Line 12: | Line 12: | ||
==Parameters== | ==Parameters== | ||
''This function has no parameters'' | ''This function has no parameters'' | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
Returns the handle to an empty position | Returns the handle to an empty position | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | 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 | ||
| + | |} | ||
| + | |||
| + | This is useful for building a position from scratch, and may be thought of as an 'empty' position. | ||
| + | |||
==Examples== | ==Examples== | ||
| Line 25: | Line 41: | ||
* 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 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a handle to an empty position
Contents
Parameters
This function has no parameters
Return value
Returns the handle to an empty position
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()
No additional examples
