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]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''ScaleTo'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Sets the objects scale to a value&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|ScaleTo]]
+|-
-</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
-:''The default value for this parameter is: '''''this'''
+| width="90%" | X
+|-
-[[Variable types|FLOAT]] ''X''
+| colspan="2" | The local X scale to set to&nbsp;
-:The local X scale to set to
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-[[Variable types|FLOAT]] ''Y''
+| width="90%" | Y
-:The local Y scale to set to
+|-
+| colspan="2" | The local Y scale to set to&nbsp;
-[[Variable types|FLOAT]] ''Z''
+|-
-:The local Z scale to set to
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Z
+|-
-==Return value==
+| colspan="2" | The local Z scale to set to&nbsp;
-''This call does not return a value''
+|-
+| 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==
-''<span style="color:red;">No additional information</span>''
+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.
@@ Line 36: / Line 39: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.ScaleTo(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