API Panel.Position.SetScale: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetScale
Sets an objects scale based on a position
- HANDLE	Dest
The position or component to update
- HANDLE	Source
The position or component to read from
- BOOL	Return

Detailed description

This is equivalent to the call to Set, except that the coordinates and rotation of the position are omitted. These may be set with SetCoords and SetRotation.

This call is useful for building up a position from multiple sources.

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Panel.Position.SetScale(dest, source)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets an objects scale based on a position
+|-
+| 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" | '''SetScale'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Sets an objects scale based on a position&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|SetScale]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Dest
+|-
-==Parameters==
+| colspan="2" | The position or component to update&nbsp;
-[[Variable Types|HANDLE]] ''Dest''
+|-
-:The position or component to update
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Source
-[[Variable Types|HANDLE]] ''Source''
+|-
-:The position or component to read from
+| colspan="2" | The position or component to read from&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-''This call does not return a value''
+|}
@@ Line 33: / Line 33: @@
 ==Examples==
 ===Calling in a calculation===
-* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.SetScale(dest, source)</pre>
+* Declare a variable 'result' of type BOOL
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetScale(dest, source)</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