API Panel.Position.ScaleTo: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	ScaleTo
Sets the objects scale to a value
- HANDLE	Handle
The position or component to update
- FLOAT	X
The local X scale to set to
- FLOAT	Y
The local Y scale to set to
- FLOAT	Z
The local Z scale to set to
- 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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets the objects scale to a value
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''ScaleTo'''
+|-
+| colspan="2" | Sets the objects scale to 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 set to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Y
+|-
+| colspan="2" | The local Y scale to set to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Z
+|-
+| colspan="2" | The local Z scale to set to&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===
-:Panel
-::Position
-:::ScaleTo
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Handle''
+This sets the scale of the ''Handle'' object to 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
-:''The default value for this parameter is: '''''this'''
-''[[Variable types|FLOAT]] X''
-:The local X scale to set to
-''[[Variable types|FLOAT]] Y''
-:The local Y scale to set to
-''[[Variable types|FLOAT]] Z''
-:The local Z scale to set to
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''No additional information''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleTo(handle, x, y, z)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation