BIS fnc rotateVector3D: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
(fill page)
Line 9: Line 9:
<!---|eff= local |Multiplayer Effects=--->
<!---|eff= local |Multiplayer Effects=--->


| <pre>/*
| Rotates the vector around the given axis by the given angle |Description=
* Author: Zozo
* Rotates the vector around the given axis by the given angle
*
* Arguments:
* 0: _vector ARRAY [x,y,z]
* 1: _angle SCALAR (accepts also negative numbers)
* 2: _axis (AXIS_X - 0, AXIS_Y - 1 AXIS_Z - 2)
*
* Return Value:
* ARRAY [x,y,z]
*
* Example:
[vectorDir player, 90, AXIS_Z] call BIS_rotateVector;
*
*
* Dependency: BIS_fnc_multiplySquareMatrixByVector
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_rotateVector3D]]|Syntax=
|[vector, angle, axis] call [[BIS_fnc_rotateVector3D]]|Syntax=


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p1= [vector, angle, axis]: [[Array]] |Parameter 1=
|p2= vector: [[Array]] - given vector in format [[Vector3D]] |Parameter 2=
|p3= angle: [[Number]] - given angle (taken in the opposite direction to the one defined by the [https://en.wikipedia.org/wiki/Right-hand_rule right hand rule]) |Parameter 3=
|p4= axis: [[Number]] - rotation axis:
* 0 - '''X''' axis
* 1 - '''Y''' axis
* 2 - '''Z''' axis|Parameter 4=
|[[Array]] - rotated vector in format [[Vector3D]]|Return value=


|Datatype - description|Return value=
|x1= <code> <nowiki>[</nowiki>[[vectorDir]] [[player]], 90, 2] [[call]] [[BIS_fnc_rotateVector3D]];</code>|Example 1=


|x1= <code></code>|Example 1=
| [[BIS_fnc_transformVectorDirAndUp]], [[BIS_fnc_rotateVector2D]] |See also=
 
| |See also=
}}
}}



Revision as of 14:23, 17 November 2019

Hover & click on the images for description

Description

Description:
Rotates the vector around the given axis by the given angle
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[vector, angle, axis] call BIS_fnc_rotateVector3D
Parameters:
[vector, angle, axis]: Array
vector: Array - given vector in format Vector3D
angle: Number - given angle (taken in the opposite direction to the one defined by the right hand rule)
axis: Number - rotation axis:
  • 0 - X axis
  • 1 - Y axis
  • 2 - Z axis
Return Value:
Array - rotated vector in format Vector3D

Examples

Example 1:
[vectorDir player, 90, 2] call BIS_fnc_rotateVector3D;

Additional Information

See also:
BIS_fnc_transformVectorDirAndUpBIS_fnc_rotateVector2D

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note