API Panel.Position.Set - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:47Z

2023-01-16T11:41:20Z

2014-01-16T15:57:56Z

XML import

2013-08-09T14:27:27Z

XML import of API documentation

2013-06-17T09:58:03Z

XML import of updated API docs

2013-06-12T22:34:25Z

2013-06-10T11:09:11Z

XML Import to change Variable types into Variable Types

2013-05-22T13:23:02Z

XML import of new API docs

2013-05-15T16:10:32Z

Flowcode example file

2013-05-15T16:09:40Z

← Older revision		Revision as of 11:54, 16 January 2023
Line 32:		Line 32:
	* 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.Set(dest, source)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Set(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 position based on a component or pre-defined 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;" | '''Set'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Sets an objects position based on a component or pre-defined position&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|Set]]
+|-
-</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 position based on a component or pre-defined position		Sets an objects position based on a component or pre-defined 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 position based on a component or pre-defined position		Sets an objects position based on a component or pre-defined position

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

← Older revision		Revision as of 22:34, 12 June 2013
Line 23:		Line 23:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	This copies the entire contents of a ''position'' from ''Source'' to ''Dest''. Either handle may be a position or component.
		+
		+	The position will be converted from the sources coordinate-space into the destination space when it is assigned. This means one unit in the ''Source'' space is equivalent to one unit in the ''Dest'' space, regardless of the scale of owning components.

← 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 position based on a component or pre-defined position		Sets an objects position based on a component or pre-defined position

@@ Line 31: / Line 31: @@
 ===Flowcode example file===
-Download [[File:SIMAPI_Panel_Position_Set.fcf]] into Flowcode. In this example, there are two spheres. The red sphere has dimensions of 24h,24w,24d, the yellow sphere has dimensions of 12h,12w,12d. This is an important consideration when using the Set() function because it effectively clones the dimensions and coordinates of the source component.
+Download [[File:SIMAPI_Panel_Position_Set.fcf]] and open it in Flowcode v6. In this example, there are two spheres. The red sphere has dimensions of 24h,24w,24d, the yellow sphere has dimensions of 12h,12w,12d. This is an important consideration when using the Set() function because it effectively clones the dimensions and coordinates of the source component.
 What you will see in this demo is the red sphere move to the coordinates of the yellow sphere and also the red sphere will be resized to that of the yellow sphere. As there are now two objects of exact same dimensions and coordinates the red sphere may look like its dissapeared or you may see both spheres exhibiting some colour collision. The LCD will show the coordinates of both spheres.