Difference between revisions of "API Panel.Position.Set"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (23 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set''' | ||
| + | |- | ||
| + | | colspan="2" | Sets an objects position based on a component or pre-defined position | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Dest | ||
| + | |- | ||
| + | | colspan="2" | The position or component to update | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Source | ||
| + | |- | ||
| + | | colspan="2" | The position or component to read from | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | == | + | ==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> | |
| − | |||
| − | * Add to a calculation icon: ::Panel.Position.Set(dest, source) | ||
Latest revision as of 11:54, 16 January 2023
|
Set |
| Sets an objects position based on a component or pre-defined position | |
 - HANDLE
|
Dest |
| The position or component to update | |
| - HANDLE
|
Source |
| The position or component to read from | |
 - BOOL
|
Return |
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)
