Difference between revisions of "API Panel.Position.GetBox"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a handle to an object representing the components bounding box position | Gets a handle to an object representing the components bounding box position | ||
| Line 23: | Line 23: | ||
==Detailed description== | ==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]] | ||
| + | |} | ||
| Line 31: | Line 38: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a handle to an object representing the components bounding box position
Contents
Parameters
HANDLE Handle
- The position or component to read from
- The default value for this parameter is: this
Return value
Returns the handle to an object representing the components bounding box position
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)
No additional examples
