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

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
 
(6 intermediate revisions by 2 users not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetCoords'''
 +
|-
 +
| colspan="2" | Sets an objects coordinates based on a position&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Dest
 +
|-
 +
| colspan="2" | The position or component to update&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Source
 +
|-
 +
| 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
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Panel|Panel]]
 
−
:[[API Panel.Position|Position]]
 
−
::[[API Panel.Position|SetCoords]]
 
−
</div>
 
−
__TOC__
 
  
−
==Parameters==
+
==Detailed description==
−
[[Variable Types|HANDLE]] ''Dest''
+
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]].
−
:The position or component to update
 
−
 
 
−
[[Variable Types|HANDLE]] ''Source''
 
−
:The position or component to read from
 
−
 
 
−
 
 
−
==Return value==
 
−
''This call does not return a value''
 
  
  
−
==Detailed description==
+
This call is useful for building up a position from multiple sources.
−
''<span style="color:red;">No additional information</span>''
 
  
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===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>
−
===Flowcode example file===
 
−
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.
 
−
 
 
−
[[File:SIMAPI_Panel_Position_SetCoords_Pic1.png]][[File:SIMAPI_Panel_Position_SetCoords_Pic2.png]]
 
−
[[File:SIMAPI_Panel_Position_SetCoords_Pic0.png|800px]]
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetCoords
Sets an objects coordinates based on a position 
Fc9-h32-icon.png - HANDLE Dest
The position or component to update 
Fc9-h32-icon.png - HANDLE Source
The position or component to read from 
Fc9-bool-icon.png - BOOL Return


Detailed description

This is equivalent to the call to Set, except that the scale and rotation of the position are omitted. These may be set with SetScale and SetRotation.


This call is useful for building up a position from multiple sources.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Panel.Position.SetCoords(dest, source)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Position.SetCoords&oldid=30161"