Difference between revisions of "API Panel.Position.SetRotation"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Sets an objects orientation based on a position
 
Sets an objects orientation based on a position
  
Line 19: Line 19:
  
 
==Return value==
 
==Return value==
''This call does not return a value''
+
[[Variable Types|BOOL]]
 +
 
 +
Returns true if the operation is a success, else false
  
  
Line 33: Line 35:
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.SetRotation(dest, source)</pre>
+
* 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 information</span>''
+
''<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

Class hierarchy

Panel

Position
SetRotation

Parameters

HANDLE Dest

The position or component to update

HANDLE Source

The position or component to read from


Return value

BOOL

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