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

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Sets an objects scale based on a position
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetScale'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets an objects scale based on a position&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.Position|Position]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.Position|SetScale]]
+
| width="90%" | Dest
</div>
+
|-
__TOC__
+
| colspan="2" | The position or component to update&nbsp;
 
+
|-
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
[[Variable Types|HANDLE]] ''Dest''
+
| width="90%" | Source
:The position or component to update
+
|-
 
+
| colspan="2" | The position or component to read from&nbsp;
[[Variable Types|HANDLE]] ''Source''
+
|-
: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''
 
+
|}
==Return value==
 
[[Variable Types|BOOL]]
 
 
 
Returns true if the operation is a success, else false
 
  
  
Line 39: Line 35:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetScale(dest, source)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetScale(dest, source)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetScale
Sets an objects scale based on a position 
Fc9-h32-icon.png - HANDLE Dest
The position or component to update 
Fc9-h32-icon.png - HANDLE Source
The position or component to read from 
Fc9-bool-icon.png - BOOL Return


Detailed description

This is equivalent to the call to Set, except that the coordinates and rotation of the position are omitted. These may be set with SetCoords 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.SetScale(dest, source)