BIS fnc terrainGradAngle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Geometry
____________________________________________________________________________________________


| Returns the gradient angle (in radians) of the terrain at a specified position and a compass direction.
|descr= Returns the gradient angle (in radians) of the terrain at a specified position and a compass direction.
It is an angle of the slope of a tangent plane to the terrain at the specified position in the specified direction. |Description=
It is an angle of the slope of a tangent plane to the terrain at the specified position in the specified direction.
____________________________________________________________________________________________


| <!-- [object, direction, delta] call [[BIS_fnc_terrainGradAngle]]; --> |Syntax=
|s1= <!-- [object, direction, delta] call [[BIS_fnc_terrainGradAngle]]; -->


|p1= object: [[Object]] or [[Position]] |Parameter 1=
|p1= object: [[Object]] or [[Position]]


|p2= direction: [[Number]] - direction where should be gradient calculated (compass direction) |Parameter 2=
|p2= direction: [[Number]] - direction where should be gradient calculated (compass direction)


|p3= delta: [[Number]] - which stepsize should be used |Parameter 3=
|p3= delta: [[Number]] - which stepsize should be used


| [[Number]] - gradient angle in radians |Return value=
|r1= [[Number]] - gradient angle in radians
____________________________________________________________________________________________


|x1= <code>_radGrad = <nowiki>[</nowiki>[[getPos]] [[player]], [[getDir]] [[player]]] [[call]] [[BIS_fnc_terrainGradAngle]];</code> |Example 1=
|x1= <sqf>private _radGrad = [getPos player, getDir player] call BIS_fnc_terrainGradAngle;</sqf>
____________________________________________________________________________________________


| [[getDir]], [[surfaceNormal]] |See also=
|seealso= [[getDir]] [[surfaceNormal]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:terrainGradAngle}}]]
[[Category:Function Group: Geometry|{{uc:terrainGradAngle}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:terrainGradAngle}}]]

Latest revision as of 18:00, 13 July 2022

Hover & click on the images for description

Description

Description:
Returns the gradient angle (in radians) of the terrain at a specified position and a compass direction. It is an angle of the slope of a tangent plane to the terrain at the specified position in the specified direction.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
Syntax needed
Parameters:
object: Object or Position
direction: Number - direction where should be gradient calculated (compass direction)
delta: Number - which stepsize should be used
Return Value:
Number - gradient angle in radians

Examples

Example 1:
private _radGrad = [getPos player, getDir player] call BIS_fnc_terrainGradAngle;

Additional Information

See also:
getDir surfaceNormal

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