Difference between revisions of "API Panel.Position.SetCoords"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets an objects coordinates based on a position | Sets an objects coordinates based on a position | ||
Line 19: | Line 19: | ||
==Return value== | ==Return value== | ||
− | + | [[Variable Types|BOOL]] | |
+ | |||
+ | Returns true if the operation is a success, else false | ||
==Detailed description== | ==Detailed description== | ||
− | This is equivalent to the call to [[API Panel.Position.Set|Set]], except that the ''scale'' and ''rotation'' of the position are omitted. | + | This is equivalent to the call to [[API Panel.Position.Set|Set]], except that the ''scale'' and ''rotation'' of the position are omitted. These may be set with [[API Panel.Position.SetScale|SetScale]] and [[API Panel.Position.SetRotation|SetRotation]]. |
Line 31: | Line 33: | ||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
− | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.SetCoords(dest, source)</pre> | + | * Declare a variable 'result' of type BOOL |
− | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetCoords(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 coordinates based on a 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 is equivalent to the call to Set, except that the scale and rotation of the position are omitted. These may be set with SetScale and SetRotation.
This call is useful for building up a position from multiple sources.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Panel.Position.SetCoords(dest, source)
No additional examples