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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
wiki page name
+
{| 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 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| colspan="2" | The position or component to update 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | The local X scale to divide by 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | The local Y scale to divide by 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Z
 +
|-
 +
| colspan="2" | The local Z scale to divide by 
 +
|-
 +
| 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''
 +
|}
  
  
===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''
+
If any of ''X'', ''Y'' or ''Z'' is zero, that parameter is ignored.
:The local Y scale to divide by
 
  
''[[Variable types|FLOAT]] Z''
 
:The local Z scale to divide by
 
  
===Return value===
+
==Examples==
''This call does not return a value''
+
===Calling in a calculation===
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleDown(handle, x, y, z)</pre>
===Detailed description===
 
''No additional information''
 
 
 
===Examples===
 
====Calling in a calculation====
 
* Add to a calculation icon: ::Panel.Position.ScaleDown(handle, x, y, z)
 

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)