API Panel.Position.Set - Revision history

SteveT: Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""

2026-07-13T14:11:43Z

Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""

← Older revision		Revision as of 14:11, 13 July 2026
Line 2:		Line 2:
	\|-		\|-
	\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" ~~style~~="~~background~~-~~color:#D8C9D8; color:#4B008D;~~" \| '''Set'''		\| width="90%" class="mtx-class-macrohead" \| '''Set'''
	\|-		\|-
	\| colspan="2" \| Sets an objects position based on a component or pre-defined position		\| colspan="2" \| Sets an objects position based on a component or pre-defined position

SteveT: Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""

2026-07-13T14:08:21Z

Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""

← Older revision		Revision as of 14:08, 13 July 2026
Line 1:		Line 1:
	{\| class="mtx-class-macrotable wikitable"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" ~~style~~="~~background~~-~~color:#D8C9D8;" align="center~~" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" class="mtx-class-macrohead" \| [[File:Fc9-comp-macro.png]]
	\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Set'''		\| width="90%" style="background-color:#D8C9D8; color:#4B008D;" \| '''Set'''
	\|-		\|-

SteveT: Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable""

2026-07-13T14:07:32Z

Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable""

← Older revision		Revision as of 14:07, 13 July 2026
Line 1:		Line 1:
	{\| class="wikitable~~" style="width:60%; background-color:#FFFFFF;~~"		{\| class="mtx-class-macrotable wikitable"
	\|-		\|-
	\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]		\| width="10%" align="center" style="background-color:#D8C9D8;" align="center" \| [[File:Fc9-comp-macro.png]]

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:47Z

← 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>''~~

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:20Z

← Older revision		Revision as of 11:41, 16 January 2023
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
	:~~[[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
	[[~~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
			\|-
			\| 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~~]]		\|}

	~~Returns true if the operation is a success, else false~~

JonnyW: XML import

2014-01-16T15:57:56Z

XML import

← 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

JonnyW: XML import of API documentation

2013-08-09T14:27:27Z

XML import of API documentation

← 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

JonnyW: XML import of updated API docs

2013-06-17T09:58:03Z

XML import of updated API docs

← Older revision		Revision as of 09:58, 17 June 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 19:		Line 21:

	==Return value==		==Return value==
	~~''This call does not return~~ a ~~value''~~		[[Variable Types\|BOOL]]

			Returns true if the operation is a success, else false


Line 30:		Line 34:
	==Examples==		==Examples==
	===Calling in a calculation===		===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>
	~~===Flowcode example file===~~
	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.

	After two seconds the red sphere will re-appear back in it's original location and to it's original size. Just using the set() function alone would have successfully moved it back to it's original coordinates but it would '''not''' have resized the red sphere back to it's original dimensions.

	To return the red sphere back to it's original dimensions, a clever technique can be used by creating a variable of type Handle. Then using the get() api call we pass a copy of the red sphere's original size and coordinates to this variable. Then use set() api call again this time specifying the variable as the source handle. You can see this clearly in the flowcode example.

	~~The screenshots below show the effect and also highlight the code used by the example.~~

	~~[[File~~:~~SIMAPI_Panel_Position_Set_Pic1.png]][[File:SIMAPI_Panel_Position_Set_Pic2.png]]~~		''<span style="color:red;">No additional examples</span>''
	~~[[File:SIMAPI_Panel_Position_Set_Pic0.png\|800px]]~~

JonnyW at 22:34, 12 June 2013

2013-06-12T22:34:25Z

← 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.

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:11Z

XML Import to change Variable types into Variable Types

← Older revision		Revision as of 11:09, 10 June 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 13:		Line 11:

	==Parameters==		==Parameters==
	[[Variable ~~types~~\|HANDLE]] ''Dest''		[[Variable Types\|HANDLE]] ''Dest''
	:The position or component to update		:The position or component to update

	[[Variable ~~types~~\|HANDLE]] ''Source''		[[Variable Types\|HANDLE]] ''Source''
	:The position or component to read from		:The position or component to read from