Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / Polar.schelp
blob69b495b8ef1c03243c4986590e9b93fb1b479cf9
1 class:: Polar
2 summary:: Polar coordinates
3 related:: Classes/Point, Classes/Complex
4 categories:: Math
6 description::
7 Represents polar coordinates.
9 classmethods::
11 method:: new
12 Create a new polar coordinate with the given radius, rho, and angle in radians, theta.
16 instancemethods::
18 subsection:: Math
19 method:: +, -, *, /
20 The math operations of addition, subtraction, multiplication and division are accomplished by
21 first converting to complex numbers.
23 method:: scale
24 Scale the radius by some value.
26 method:: rotate
27 Rotate the angle by some value.
29 method:: neg
30 Rotate by pi.
33 subsection:: Conversion
35 method:: magnitude
36 Answer the radius.
38 method:: angle
39 Answer the angle in radians
41 method:: phase
42 Answer the angle in radians
44 method:: real
45 Answer the real part.
47 method:: imag
48 Answer the imaginary part.
50 method:: asComplex
51 Convert to Complex
53 method:: asPoint
54 Convert to Point