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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets an objects scale based on a position
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetScale'''
 +
|-
 +
| colspan="2" | Sets an objects scale based on a position&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Dest
 +
|-
 +
| colspan="2" | The position or component to update&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Source
 +
|-
 +
| colspan="2" | The position or component to read from&nbsp;
 +
|-
 +
| 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''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===[[API Panel|Panel]]
 
:[[API Panel.Position|Position]]
 
::[[API Panel.Position|SetScale]]
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''[[Variable types|HANDLE]] Dest''
+
This is equivalent to the call to [[API Panel.Position.Set|Set]], except that the ''coordinates'' and ''rotation'' of the position are omitted. These may be set with [[API Panel.Position.SetCoords|SetCoords]] and [[API Panel.Position.SetRotation|SetRotation]].
:The position or component to update
+
 
 +
 
 +
This call is useful for building up a position from multiple sources.
  
''[[Variable types|HANDLE]] Source''
 
:The position or component to read from
 
  
==Return value==
 
''This call does not return a value''
 
  
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.SetScale(dest, source)</pre>
+
* Declare a variable 'result' of type BOOL
 +
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetScale(dest, source)</pre>

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)