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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Multiplies the objects scale by a value
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScaleUp'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Multiplies the objects scale by a value&nbsp;
:[[API Panel.Position|Position]]
+
|-
::[[API Panel.Position|ScaleUp]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | Handle
 
+
|-
==Parameters==
+
| colspan="2" | The position or component to update&nbsp;
[[Variable types|HANDLE]] ''Handle''
+
|-
:The position or component to update
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
+
| width="90%" | X
[[Variable types|FLOAT]] ''X''
+
|-
:The local X scale to multiply by
+
| colspan="2" | The local X scale to multiply by&nbsp;
 
+
|-
[[Variable types|FLOAT]] ''Y''
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
:The local Y scale to multiply by
+
| width="90%" | Y
 
+
|-
[[Variable types|FLOAT]] ''Z''
+
| colspan="2" | The local Y scale to multiply by&nbsp;
:The local Z scale to multiply by
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
==Return value==
+
| width="90%" | Z
''This call does not return a value''
+
|-
 +
| colspan="2" | The local Z scale to multiply by&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
This multiplies the scale of the ''Handle'' object by an absolute value. Note the difference between [[Object Scale|scale and size]]. An objects scale is only equal to its size if it has no child objects to define its boundary.
  
  
Line 34: Line 39:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleUp(handle, x, y, z)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleUp(handle, x, y, z)</pre>
 
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png ScaleUp
Multiplies the objects scale by 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 multiply by 
Fc9-f32-icon.png - FLOAT Y
The local Y scale to multiply by 
Fc9-f32-icon.png - FLOAT Z
The local Z scale to multiply by 
Fc9-void-icon.png - NONE Return


Detailed description

This multiplies the scale of the Handle object by 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.ScaleUp(handle, x, y, z)