Difference between revisions of "API Panel.Position.RotateAlong"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Rotates the object by the given rotation along an axis | Rotates the object by the given rotation along an axis | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Panel | ||
| + | ::Position | ||
| + | :::RotateAlong | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The position or component to update | :The position or component to update | ||
| Line 26: | Line 33: | ||
:''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.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre> |
Revision as of 16:09, 11 May 2013
<sidebar>API contents</sidebar> Rotates the object by the given rotation along an axis
Class hierarchy
- Panel
- Position
- RotateAlong
- Position
Contents
Parameters
HANDLE Handle
- The position or component to update
- The default value for this parameter is: this
HANDLE Pivot
- The coordinates of the rotation center
HANDLE Axis
- An axis to align the angles to
FLOAT X_Pitch
- The local X degrees to increment by
- The default value for this parameter is: 0
FLOAT Y_Yaw
- The local Y degrees to increment by
- The default value for this parameter is: 0
FLOAT Z_Roll
- The local Z degrees 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.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)
