API Panel.Position.ScaleDown: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	ScaleDown
Divides the objects scale by a value
- HANDLE	Handle
The position or component to update
- FLOAT	X
The local X scale to divide by
- FLOAT	Y
The local Y scale to divide by
- FLOAT	Z
The local Z scale to divide by
- 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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Divides the objects scale by a value
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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 35: / Line 42: @@
 ===Calling in a calculation===
 * 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>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation