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

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Moves the object to the given coordinates relative to its parent
 
Moves the object to the given coordinates relative to its parent
  
Line 30: Line 30:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
This moves a position to a set of absolute coordinates in its parents coordinate space. That is, the center of the parent object is considered to be (0, 0, 0).
 +
 
 +
 
 +
This call is a compliment to [[API Panel.Position.MoveBy|MoveBy]].
  
  
Line 39: Line 42:
  
 
===Flowcode example file===
 
===Flowcode example file===
Download [[File:SIMAPI_Panel_Position_MoveTo.fcf]] and open it in Flowcode v6. In this example, there are three cubiods that represent Axis X,Y,Z. Note they are coloured exactly as the panel axis indicator which represents your viewing position. There is a sphere also on the panel.  
+
Download {{Fcfile|SIMAPI_Panel_Position_MoveTo.fcfx|SIMAPI_Panel_Position_MoveTo}} and open it in Flowcode v6. In this example, there are three cubiods that represent Axis X,Y,Z. Note they are coloured exactly as the panel axis indicator which represents your viewing position. There is a sphere also on the panel.  
  
 
The MoveTo(h,x,y,z) function moves the object specified to a new set of coordinates. In the example file, the program moves the sphere from it's original location of x10,y10,z0 to x100,y75,z0, waits a second and then moves the sphere back to it's original coordinates.
 
The MoveTo(h,x,y,z) function moves the object specified to a new set of coordinates. In the example file, the program moves the sphere from it's original location of x10,y10,z0 to x100,y75,z0, waits a second and then moves the sphere back to it's original coordinates.

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Moves the object to the given coordinates relative to its parent

Class hierarchy

Panel

Position
MoveTo

Parameters

HANDLE Handle

The position or component to update
The default value for this parameter is: this

FLOAT X

Local coordinate X to update with

FLOAT Y

Local coordinate Y to update with

FLOAT Z

Local coordinate Z to update with


Return value

This call does not return a value


Detailed description

This moves a position to a set of absolute coordinates in its parents coordinate space. That is, the center of the parent object is considered to be (0, 0, 0).


This call is a compliment to MoveBy.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.Position.MoveTo(handle, x, y, z)


Flowcode example file

Download FC6 Icon.png SIMAPI_Panel_Position_MoveTo and open it in Flowcode v6. In this example, there are three cubiods that represent Axis X,Y,Z. Note they are coloured exactly as the panel axis indicator which represents your viewing position. There is a sphere also on the panel.

The MoveTo(h,x,y,z) function moves the object specified to a new set of coordinates. In the example file, the program moves the sphere from it's original location of x10,y10,z0 to x100,y75,z0, waits a second and then moves the sphere back to it's original coordinates.

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

SIMAPI Panel Position MoveTo Pic1.pngSIMAPI Panel Position MoveTo Pic2.png SIMAPI Panel Position MoveTo Pic0.png