This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 226
Expand file tree
/
Copy pathatan2.lcdoc
More file actions
56 lines (38 loc) · 1.41 KB
/
atan2.lcdoc
File metadata and controls
56 lines (38 loc) · 1.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Name: atan2
Type: function
Syntax: atan2(<yCoordinate>, <xCoordinate>)
Summary:
<return|Returns> the arc tangent of one number divided by another, using
the <sign> of both.
Introduced: 1.0
OS: mac, windows, linux, ios, android
Platforms: desktop, server, mobile
Example:
atan2(-1,-1) -- returns 4/3 * pi
Example:
atan2(thisNumber,thatNumber)
Parameters:
yCoordinate:
A number or an expression that evaluates to a number.
xCoordinate:
A number or an expression that evaluates to a number.
Returns:
The <atan2> <function> <return|returns> a number between -pi and pi.
The result:
The result of the <atan2> <function> is <return|returned> in
<radian|radians>. To get this result in <degree|degrees>, use the
following <custom function>:
function atan2InDegrees pFirstArg,pSecondArg
return atan2(pFirstArg,pSecondArg) * 180 / pi
end atan2InDegrees
Description:
Use the <atan2> <function> to find the arc tangent of one number divided
by another when <sign> is significant.
In most cases, atan2(y,x) is equal to atan(y/x). However, if both x and
y are negative, the sign of x/y is positive. In this case, the atan
function <return|returns> an angle in the first quadrant, but the
<atan2> <function> <return|returns> an angle in the third quadrant.
References: pi (constant), function (control structure), sign (glossary),
radian (glossary), custom function (glossary), return (glossary),
degree (glossary)
Tags: math