Difference between revisions of "API Panel.Position.GetBox"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Gets a handle to an object representing the components bounding box position | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBox''' | ||
| + | |- | ||
| + | | colspan="2" | Gets a handle to an object representing the components bounding box position | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The position or component to read from | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | ''[[ | + | 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 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]] | ||
| + | |} | ||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre> |
Latest revision as of 11:54, 16 January 2023
|
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)
