API Panel.Position.GetBox: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetBox
Gets a handle to an object representing the components bounding box position
- HANDLE	Handle
The position or component to read from
- HANDLE	Return

Detailed description

This call gets the objects bounding box position. This can be thought of as the objects size rather than its raw scale value.

The difference between scale and size only applies to objects with child objects, such as groups or compiled components.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Panel.Position.GetBox(handle)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets a handle to an object representing the components bounding box position
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetBox'''
+|-
+| colspan="2" | Gets a handle to an object representing the components bounding box position&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The position or component to read from&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Handle''
+This call gets the objects bounding box position. This can be thought of as the objects ''[[Object_Scale|size]]'' rather than its raw scale value.
-:The position or component to read from
-:''The default value for this parameter is: '''''this'''
-===Return value===
-[[Variable types|HANDLE]]
-Returns the handle to an object representing the components bounding box position
+The difference between [[Object Scale|scale and size]] only applies to objects with [[Component Tree|child objects]], such as groups or compiled components.
+{|
+|-
+| [[File:SIMAPI Panel.Position.GetBox.svg|thumb|150px|Scale and size of the box]]
+|}
-===Detailed description===
-''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type HANDLE
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Panel.Position.GetBox(handle)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation