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

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 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 the objects scale to a value
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScaleTo'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets the objects scale to a value&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.Position|Position]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.Position|ScaleTo]]
+
| width="90%" | Handle
</div>
+
|-
__TOC__
+
| colspan="2" | The position or component to update&nbsp;
 
+
|-
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
[[Variable Types|HANDLE]] ''Handle''
+
| width="90%" | X
:The position or component to update
+
|-
:''The default value for this parameter is: '''''this'''
+
| colspan="2" | The local X scale to set to&nbsp;
 
+
|-
[[Variable Types|FLOAT]] ''X''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
:The local X scale to set to
+
| width="90%" | Y
 
+
|-
[[Variable Types|FLOAT]] ''Y''
+
| colspan="2" | The local Y scale to set to&nbsp;
:The local Y scale to set to
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
[[Variable Types|FLOAT]] ''Z''
+
| width="90%" | Z
:The local Z scale to set to
+
|-
 
+
| colspan="2" | The local Z scale to set to&nbsp;
 
+
|-
==Return value==
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
''This call does not return a value''
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
Line 38: Line 39:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleTo(handle, x, y, z)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleTo(handle, x, y, z)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png ScaleTo
Sets the objects scale to a value 
Fc9-h32-icon.png - HANDLE Handle
The position or component to update 
Fc9-f32-icon.png - FLOAT X
The local X scale to set to 
Fc9-f32-icon.png - FLOAT Y
The local Y scale to set to 
Fc9-f32-icon.png - FLOAT Z
The local Z scale to set to 
Fc9-void-icon.png - NONE Return


Detailed description

This sets the scale of the Handle object to an absolute value. Note the difference between scale and size. An objects scale is only equal to its size if it has no child objects to define its boundary.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.Position.ScaleTo(handle, x, y, z)