API Panel.Position.SetCoords - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:47Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:21Z

JonnyW: XML import

2014-01-16T15:57:56Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:27Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:58:03Z

XML import of updated API docs

JonnyW at 23:51, 13 June 2013

2013-06-13T23:51:33Z

JonnyW at 23:50, 13 June 2013

2013-06-13T23:50:25Z

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:12Z

XML Import to change Variable types into Variable Types

JonnyW: XML import of new API docs

2013-05-22T13:23:02Z

XML import of new API docs

at 16:12, 15 May 2013

2013-05-15T16:12:38Z

← Older revision		Revision as of 11:54, 16 January 2023
Line 33:		Line 33:
	* Declare a variable 'result' of type BOOL		* Declare a variable 'result' of type BOOL
	* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetCoords(dest, source)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetCoords(dest, source)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Sets an objects coordinates based on a 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;" | '''SetCoords'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Sets an objects coordinates based on a position&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|SetCoords]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Dest
+|-
-==Parameters==
+| colspan="2" | The position or component to update&nbsp;
-[[Variable Types|HANDLE]] ''Dest''
+|-
-:The position or component to update
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Source
-[[Variable Types|HANDLE]] ''Source''
+|-
-:The position or component to read from
+| colspan="2" | The position or component to read from&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-[[Variable Types|BOOL]]
+|}

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Sets an objects coordinates based on a position		Sets an objects coordinates based on a position

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Sets an objects coordinates based on a position		Sets an objects coordinates based on a position

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Sets an objects coordinates based on a position
@@ Line 19: / Line 21: @@
 ==Return value==
-''This call does not return a value''
+[[Variable Types|BOOL]]
@@ Line 31: / Line 35: @@
 ==Examples==
 ===Calling in a calculation===
-* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.SetCoords(dest, source)</pre>
+* Declare a variable 'result' of type BOOL
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.SetCoords(dest, source)</pre>
-[[File:SIMAPI_Panel_Position_SetCoords_Pic1.png]][[File:SIMAPI_Panel_Position_SetCoords_Pic2.png]]
+''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 23:51, 13 June 2013
Line 23:		Line 23:

	==Detailed description==		==Detailed description==
−	This is equivalent to the call to [[API Panel.Position.Set\|Set]], except that the ''scale'' and ''rotation'' of the position are omitted.	+	This is equivalent to the call to [[API Panel.Position.Set\|Set]], except that the ''scale'' and ''rotation'' of the position are omitted. These may be set with [[API Panel.Position.SetScale\|SetScale]] and [[API Panel.Position.SetRotation\|SetRotation]].

← Older revision		Revision as of 23:50, 13 June 2013
Line 23:		Line 23:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	This is equivalent to the call to [[API Panel.Position.Set\|Set]], except that the ''scale'' and ''rotation'' of the position are omitted.
		+
		+
		+	This call is useful for building up a position from multiple sources.

← Older revision		Revision as of 13:23, 22 May 2013
Line 1:		Line 1:
		+
		+
	<sidebar>API contents</sidebar>		<sidebar>API contents</sidebar>
	Sets an objects coordinates based on a position		Sets an objects coordinates based on a position

@@ Line 31: / Line 31: @@
 ===Flowcode example file===
-From the '''SimulationAPIExamples''' folder load '''SIMAPI_Panel_Position_SetCoords.fcf''' file into Flowcode. In this example there are two spheres (sourceball & destinationball) and a LCD showing the coordinates of each sphere. Every two seconds the program will move the red sphere to the coordinates of the yellow sphere, and then return the red sphere to its original position. The red sphere is slightly larger than the yellow sphere. This is purely to illustrate the red sphere moves to its correct destination (if the spheres are the exact same size then you may or may not see the red sphere properly as the program is rendering two spheres of exact dimensions in exactly the same coordinates)
+Download [[File:SIMAPI_Panel_Position_SetCoords.fcf]] and open it in Flowcode v6. In this example there are two spheres (sourceball & destinationball) and a LCD showing the coordinates of each sphere. Every two seconds the program will move the red sphere to the coordinates of the yellow sphere, and then return the red sphere to its original position. The red sphere is slightly larger than the yellow sphere. This is purely to illustrate the red sphere moves to its correct destination (if the spheres are the exact same size then you may or may not see the red sphere properly as the program is rendering two spheres of exact dimensions in exactly the same coordinates)
 The screenshots below show the effect and also highlight the code used by the example.