Difference between revisions of "API Panel.Position.Set"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (20 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Sets an objects position based on a component or pre-defined position | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|Set]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Dest'' | |
:The position or component to update | :The position or component to update | ||
| − | + | [[Variable Types|HANDLE]] ''Source'' | |
:The position or component to read from | :The position or component to read from | ||
| − | |||
| − | |||
| − | ===Detailed description== | + | ==Return value== |
| − | '' | + | [[Variable Types|BOOL]] |
| + | |||
| + | Returns true if the operation is a success, else false | ||
| + | |||
| + | |||
| + | ==Detailed description== | ||
| + | This copies the entire contents of a ''position'' from ''Source'' to ''Dest''. Either handle may be a position or component. | ||
| + | |||
| + | The position will be converted from the sources coordinate-space into the destination space when it is assigned. This means one unit in the ''Source'' space is equivalent to one unit in the ''Dest'' space, regardless of the scale of owning components. | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Declare a variable 'result' of type BOOL | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Set(dest, source)</pre> | ||
| − | = | + | ''<span style="color:red;">No additional examples</span>'' |
| − | |||
| − | |||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets an objects position based on a component or pre-defined position
Contents
Parameters
HANDLE Dest
- The position or component to update
HANDLE Source
- The position or component to read from
Return value
Returns true if the operation is a success, else false
Detailed description
This copies the entire contents of a position from Source to Dest. Either handle may be a position or component.
The position will be converted from the sources coordinate-space into the destination space when it is assigned. This means one unit in the Source space is equivalent to one unit in the Dest space, regardless of the scale of owning components.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Panel.Position.Set(dest, source)
No additional examples
