API Panel.Position.Get - Revision history

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:20Z

JonnyW: XML import

2014-01-16T15:57:54Z

XML import

ReeceL at 13:22, 20 September 2013

2013-09-20T13:22:52Z

JonnyW: XML import of API documentation

2013-08-09T14:27:27Z

XML import of API documentation

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:08Z

XML Import to change Variable types into Variable Types

JonnyW: XML import of new API docs

2013-05-22T13:23:03Z

XML import of new API docs

at 19:51, 19 May 2013

2013-05-19T19:51:20Z

: /* Detailed description */

2013-05-19T12:31:47Z

Detailed description

: /* Calling in a calculation */

2013-05-19T12:31:02Z

Calling in a calculation

: /* Examples */

2013-05-19T12:19:06Z

Examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets a handle to an object representing the components current position
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Get'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Gets a handle to an object representing the components current position&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|Get]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The position or component to read from&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The position or component to read from
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
-:''The default value for this parameter is: '''''this'''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}

@@ Line 1: / Line 1: @@
 <sidebar>API Contents</sidebar>
 Gets a handle to an object representing the components current position
@@ Line 33: / Line 31: @@
 ===Flowcode example file===
-Download [[File:SIMAPI_Panel_Position_Get.fcfx]] and open it in Flowcode v6. In this example, a purple sphere is placed at coordinates x0,y0,z0. the sphere is moved into 4 different positions on the system panel. Each time the sphere is moved, the get() api command is called, returning a handle to the objects position into 4 previously defined variables of type handle. Once the sphere returns to the centre of the system panel, the clone() api command is called 4 times to create clones of the original sphere but placing them at the coordinates that were stored in each of the variables respectively.
+Download {{Fcfile|SIMAPI_Panel_Position_Get.fcfx|SIMAPI_Panel_Position_Get}} and open it in Flowcode v6. In this example, a purple sphere is placed at coordinates x0,y0,z0. the sphere is moved into 4 different positions on the system panel. Each time the sphere is moved, the get() api command is called, returning a handle to the objects position into 4 previously defined variables of type handle. Once the sphere returns to the centre of the system panel, the clone() api command is called 4 times to create clones of the original sphere but placing them at the coordinates that were stored in each of the variables respectively.
 Note once you have executed the flowcode program manually you will need to delete each of the 4 cloned spheres in order to run the program again (alternatively with the system panel window in focus, press Ctrl-Z to undo)

@@ Line 33: / Line 33: @@
 ===Flowcode example file===
-Download [[File:SIMAPI_Panel_Position_Get.fcf]] and open it in Flowcode v6. In this example, a purple sphere is placed at coordinates x0,y0,z0. the sphere is moved into 4 different positions on the system panel. Each time the sphere is moved, the get() api command is called, returning a handle to the objects position into 4 previously defined variables of type handle. Once the sphere returns to the centre of the system panel, the clone() api command is called 4 times to create clones of the original sphere but placing them at the coordinates that were stored in each of the variables respectively.
+Download [[File:SIMAPI_Panel_Position_Get.fcfx]] and open it in Flowcode v6. In this example, a purple sphere is placed at coordinates x0,y0,z0. the sphere is moved into 4 different positions on the system panel. Each time the sphere is moved, the get() api command is called, returning a handle to the objects position into 4 previously defined variables of type handle. Once the sphere returns to the centre of the system panel, the clone() api command is called 4 times to create clones of the original sphere but placing them at the coordinates that were stored in each of the variables respectively.
 Note once you have executed the flowcode program manually you will need to delete each of the 4 cloned spheres in order to run the program again (alternatively with the system panel window in focus, press Ctrl-Z to undo)

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:
−	<sidebar>API ~~contents~~</sidebar>	+
		+
		+	<sidebar>API Contents</sidebar>
	Gets a handle to an object representing the components current position		Gets a handle to an object representing the components current position

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Gets a handle to an object representing the components current position
@@ Line 13: / Line 11: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''Handle''
+[[Variable Types|HANDLE]] ''Handle''
 :The position or component to read from
 :''The default value for this parameter is: '''''this'''
@@ Line 19: / Line 17: @@
 ==Return value==
-[[Variable types|HANDLE]]
+[[Variable Types|HANDLE]]
 Returns the handle to an object representing the components current position

← Older revision		Revision as of 13:23, 22 May 2013
Line 1:		Line 1:
		+
		+
	<sidebar>API contents</sidebar>		<sidebar>API contents</sidebar>
	Gets a handle to an object representing the components current position		Gets a handle to an object representing the components current position

← Older revision		Revision as of 19:51, 19 May 2013
Line 29:		Line 29:
	* Declare a variable 'result' of type HANDLE		* Declare a variable 'result' of type HANDLE
	* 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>
		+
		+	===Flowcode example file===
		+	Download [[File:SIMAPI_Panel_Position_Get.fcf]] and open it in Flowcode v6. In this example, a purple sphere is placed at coordinates x0,y0,z0. the sphere is moved into 4 different positions on the system panel. Each time the sphere is moved, the get() api command is called, returning a handle to the objects position into 4 previously defined variables of type handle. Once the sphere returns to the centre of the system panel, the clone() api command is called 4 times to create clones of the original sphere but placing them at the coordinates that were stored in each of the variables respectively.
		+
		+	Note once you have executed the flowcode program manually you will need to delete each of the 4 cloned spheres in order to run the program again (alternatively with the system panel window in focus, press Ctrl-Z to undo)
		+
		+	The screenshots below show the effect and also highlight the code used by the example.
		+
		+	[[File:SIMAPI_Panel_Position_Get_Pic0.png\|800px]]
		+	[[File:SIMAPI_Panel_Position_Get_Pic1.png\|800px]]

@@ Line 23: / Line 23: @@
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+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. This has several uses for example tracking 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.
 ==Examples==

← Older revision		Revision as of 12:31, 19 May 2013
Line 30:		Line 30:
	* Declare a variable 'result' of type HANDLE		* Declare a variable 'result' of type HANDLE
	* 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.

← Older revision		Revision as of 12:19, 19 May 2013
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>

−	~~''<span style="color:red;">No additional~~ information~~</span>'~~'	+	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.