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

Revision as of 12:31, 19 May 2013

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

HANDLE Handle

The position or component to read from

The default value for this parameter is: this

Returns the handle to an object representing the components current position

No additional information

@@ Line 30: / Line 30: @@
 * Declare a variable 'result' of type HANDLE
 * 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.