Difference between revisions of "API Panel.Position.Get"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
|||
| Line 31: | Line 31: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Get(handle)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Get(handle)</pre> | ||
| − | + | Obtaining a handle to a component provides the ability to hold information about the position and coordinates of that component at the time the api is called. It is effectively creates an invisible clone of the target object. This has several uses from duplicating components through to being able to track a position of an object prior to any changes to it's parameters. A good example how this is used can be seen by looking at the source code for the example provided in the [[API Panel.Position.Set]] wiki page. | |
Revision as of 12:19, 19 May 2013
<sidebar>API contents</sidebar> Gets a handle to an object representing the components current 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 current position
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.Position.Get(handle)
Obtaining a handle to a component provides the ability to hold information about the position and coordinates of that component at the time the api is called. It is effectively creates an invisible clone of the target object. This has several uses from duplicating components through to being able to track a position of an object prior to any changes to it's parameters. A good example how this is used can be seen by looking at the source code for the example provided in the API Panel.Position.Set wiki page.
