Include a header file required for build on mac 10.4
[supercollider.git] / Help / Geometry / Point.html
blob1229c3ab53fa17222475cbc0034b795d93966b3e
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="824.48">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica; min-height: 22.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
15 span.s1 {color: #0000ff}
16 span.s2 {text-decoration: underline}
17 span.Apple-tab-span {white-space:pre}
18 </style>
19 </head>
20 <body>
21 <p class="p1"><b>Point<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Cartesian point</b></p>
22 <p class="p2"><br></p>
23 <p class="p3"><b>Superclass: </b><a href="../Core/Object.html"><span class="s1"><b>Object</b></span></a></p>
24 <p class="p4"><br></p>
25 <p class="p3">Defines a point on the Cartesian plane.</p>
26 <p class="p4"><br></p>
27 <p class="p4"><br></p>
28 <p class="p5"><b><span class="s2">Creation</span></b></p>
29 <p class="p4"><br></p>
30 <p class="p3"><b>new(inX, inY)</b></p>
31 <p class="p4"><br></p>
32 <p class="p3">defines a new point.</p>
33 <p class="p4"><br></p>
34 <p class="p4"><br></p>
35 <p class="p5"><b><span class="s2">Accessing</span></b></p>
36 <p class="p4"><br></p>
37 <p class="p3"><b>x</b></p>
38 <p class="p4"><br></p>
39 <p class="p3">get the x coordinate value.</p>
40 <p class="p4"><br></p>
41 <p class="p3"><b>y</b></p>
42 <p class="p4"><br></p>
43 <p class="p3">get the y coordinate value.</p>
44 <p class="p4"><br></p>
45 <p class="p3"><b>x_(aValue)</b></p>
46 <p class="p4"><br></p>
47 <p class="p3">set the x coordinate value.</p>
48 <p class="p4"><br></p>
49 <p class="p3"><b>y_(aValue)</b></p>
50 <p class="p4"><br></p>
51 <p class="p3">set the y coordinate value.</p>
52 <p class="p4"><br></p>
53 <p class="p3"><b>set(inX, inY)</b></p>
54 <p class="p4"><br></p>
55 <p class="p3">Sets the point x and y values.</p>
56 <p class="p4"><br></p>
57 <p class="p4"><br></p>
58 <p class="p5"><b><span class="s2">Testing</span></b></p>
59 <p class="p4"><br></p>
60 <p class="p3"><b>== aPoint</b></p>
61 <p class="p4"><br></p>
62 <p class="p3">answers a Boolean whether the receiver equals the argument.</p>
63 <p class="p4"><br></p>
64 <p class="p3"><b>hash</b></p>
65 <p class="p4"><br></p>
66 <p class="p3">returns a hash value for the receiver.</p>
67 <p class="p4"><br></p>
68 <p class="p4"><br></p>
69 <p class="p5"><b><span class="s2">Math</span></b></p>
70 <p class="p4"><br></p>
71 <p class="p3"><b>+ aPointOrScalar</b></p>
72 <p class="p4"><br></p>
73 <p class="p3">Addition.</p>
74 <p class="p4"><br></p>
75 <p class="p3"><b>- aPointOrScalar</b></p>
76 <p class="p4"><br></p>
77 <p class="p3">Subtraction.</p>
78 <p class="p4"><br></p>
79 <p class="p3"><b>* aPointOrScalar</b></p>
80 <p class="p4"><br></p>
81 <p class="p3">Multiplication.</p>
82 <p class="p4"><br></p>
83 <p class="p3"><b>/ aPointOrScalar</b></p>
84 <p class="p4"><br></p>
85 <p class="p3">Division.</p>
86 <p class="p4"><br></p>
87 <p class="p3"><b>translate(aPoint)</b></p>
88 <p class="p4"><br></p>
89 <p class="p3">Addition by a Point.</p>
90 <p class="p4"><br></p>
91 <p class="p3"><b>scale(aPoint)</b></p>
92 <p class="p4"><br></p>
93 <p class="p3">Multiplication by a Point.</p>
94 <p class="p4"><br></p>
95 <p class="p3"><b>rotate(angle)</b></p>
96 <p class="p4"><br></p>
97 <p class="p3">Rotation about the origin by the angle given in radians.</p>
98 <p class="p4"><br></p>
99 <p class="p3"><b>abs</b></p>
100 <p class="p4"><br></p>
101 <p class="p3">Absolute value of the point.</p>
102 <p class="p4"><br></p>
103 <p class="p3"><b>rho</b></p>
104 <p class="p4"><br></p>
105 <p class="p3">return the polar coordinate radius of the receiver.</p>
106 <p class="p4"><br></p>
107 <p class="p3"><b>theta</b></p>
108 <p class="p4"><br></p>
109 <p class="p3">return the polar coordinate angle of the receiver.</p>
110 <p class="p4"><br></p>
111 <p class="p3"><b>dist(aPoint)</b></p>
112 <p class="p4"><br></p>
113 <p class="p3">return the distance from the receiver to aPoint.</p>
114 <p class="p4"><br></p>
115 <p class="p3"><b>transpose</b></p>
116 <p class="p4"><br></p>
117 <p class="p3">return a Point whose x and y coordinates are swapped.</p>
118 <p class="p4"><br></p>
119 <p class="p3"><b>round(quantum)</b></p>
120 <p class="p4"><br></p>
121 <p class="p3">round the coordinate values to a multiple of quantum.</p>
122 <p class="p4"><br></p>
123 <p class="p3"><b>trunc(quantum)</b></p>
124 <p class="p4"><br></p>
125 <p class="p3">truncate the coordinate values to a multiple of quantum.</p>
126 <p class="p4"><br></p>
127 <p class="p4"><br></p>
128 <p class="p5"><b><span class="s2">Conversion</span></b></p>
129 <p class="p4"><br></p>
130 <p class="p3"><b>asPoint</b></p>
131 <p class="p4"><br></p>
132 <p class="p3">returns the receiver.</p>
133 <p class="p4"><br></p>
134 <p class="p3"><b>asComplex</b></p>
135 <p class="p4"><br></p>
136 <p class="p3">returns a complex number with x as the real part and y as the imaginary part.</p>
137 <p class="p4"><br></p>
138 <p class="p3"><b>asString</b></p>
139 <p class="p4"><br></p>
140 <p class="p3">return a string representing the receiver.</p>
141 <p class="p4"><br></p>
142 <p class="p3"><b>asShortString</b></p>
143 <p class="p4"><br></p>
144 <p class="p3">return a short string representing the receiver.</p>
145 <p class="p4"><br></p>
146 <p class="p3"><b>paramsCompileString</b></p>
147 <p class="p4"><br></p>
148 <p class="p3">represent parameters to 'new' as compileable strings. (See Object::asCompileString)</p>
149 <p class="p4"><br></p>
150 </body>
151 </html>