Difference between revisions of "API Panel.Position.GetBox"

From Flowcode Help
Jump to navigationJump to search
Line 26: Line 26:
  
  
The difference between scale and size only applies to grouped objects, or objects with [[Component Tree|child objects]].
+
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]]
 +
|}
  
  

Revision as of 22:21, 14 June 2013

<sidebar>API contents</sidebar> Gets a handle to an object representing the components bounding box position

Class hierarchy

Panel

Position
GetBox

Parameters

HANDLE Handle

The position or component to read from
The default value for this parameter is: this


Return value

HANDLE

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.

Scale and size of the box


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.Position.GetBox(handle)

No additional information