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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Divides the objects scale by a value
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScaleDown'''
 +
|-
 +
| colspan="2" | Divides the objects scale by a value&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| colspan="2" | The position or component to update&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | The local X scale to divide by&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | The local Y scale to divide by&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Z
 +
|-
 +
| colspan="2" | The local Z scale to divide 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''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Panel|Panel]]
 
:[[API Panel.Position|Position]]
 
::[[API Panel.Position|ScaleDown]]
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
[[Variable types|HANDLE]] ''Handle''
+
This divides 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.
:The position or component to update
 
 
 
[[Variable types|FLOAT]] ''X''
 
:The local X scale to divide by
 
 
 
[[Variable types|FLOAT]] ''Y''
 
:The local Y scale to divide by
 
 
 
[[Variable types|FLOAT]] ''Z''
 
:The local Z scale to divide by
 
  
==Return value==
 
''This call does not return a value''
 
  
==Detailed description==
+
If any of ''X'', ''Y'' or ''Z'' is zero, that parameter is ignored.
''<span style="color:red;">No additional information</span>''
 
  
  
Line 33: Line 42:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleDown(handle, x, y, z)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleDown(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 ScaleDown
Divides 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 divide by 
Fc9-f32-icon.png - FLOAT Y
The local Y scale to divide by 
Fc9-f32-icon.png - FLOAT Z
The local Z scale to divide by 
Fc9-void-icon.png - NONE Return


Detailed description

This divides 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.


If any of X, Y or Z is zero, that parameter is ignored.


Examples

Calling in a calculation

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