API Panel.Position.MoveAlong

<sidebar>API contents</sidebar> Moves the object by the given offset relative to its parent along an axis

Parameters

HANDLE Handle

The position or component to update

The default value for this parameter is: this

HANDLE Axis

A position or component representing the X,Y,Z axis to move in

FLOAT X

Local coordinate X to increment by

The default value for this parameter is: 0

FLOAT Y

Local coordinate Y to increment by

The default value for this parameter is: 0

FLOAT Z

Local coordinate Z to increment by

The default value for this parameter is: 0

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

• Add to a calculation icon:

  ::Panel.Position.MoveAlong(handle, axis, x, y, z)

Flowcode example file

From the SimulationAPIExamples folder load SIMAPI_Panel_Position_MoveAlong.fcf file into Flowcode. 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 sphere moves first along the X-Axis 100 units then back to it's original position, then does the same for the Y and Z axis. Note - to see the sphere moving along the Z axis you will need to turn on perspective or change the viewing plane with via the panel axis indicator.

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