Difference between revisions of "API Panel.Position.SetRotation"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <sidebar>API Contents</sidebar> |
Sets an objects orientation based on a position | Sets an objects orientation based on a position | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|SetRotation]] | ||
| + | </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 | ||
| − | |||
| − | |||
| − | == | + | ==Return value== |
| − | + | [[Variable Types|BOOL]] | |
| − | ===Examples | + | Returns true if the operation is a success, else false |
| − | + | ||
| − | * Add to a calculation icon: ::Panel.Position.SetRotation(dest, source) | + | |
| + | ==Detailed description== | ||
| + | This is equivalent to the call to [[API Panel.Position.Set|Set]], except that the ''coordinates'' and ''scale'' of the position are omitted. These may be set with [[API Panel.Position.SetCoords|SetCoords]] and [[API Panel.Position.SetScale|SetScale]]. | ||
| + | |||
| + | |||
| + | 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: <pre class="brush:[cpp]">result = ::Panel.Position.SetRotation(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 orientation 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 coordinates and scale of the position are omitted. These may be set with SetCoords and SetScale.
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.SetRotation(dest, source)
No additional examples
