API Panel.Position.MoveAlong: Difference between revisions
Appearance
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Moves the object by the given offset relative to its parent along an axis | Moves the object by the given offset relative to its parent along an axis | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Panel | |||
::Position | |||
:::MoveAlong | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The position or component to update | :The position or component to update | ||
| Line 23: | Line 30: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
==Return value== | |||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.MoveAlong(handle, axis, x, y, z)</pre> | ||
Revision as of 16:06, 11 May 2013
<sidebar>API contents</sidebar> Moves the object by the given offset relative to its parent along an axis
Class hierarchy
- Panel
- Position
- MoveAlong
- Position
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)