-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCoord.html
942 lines (942 loc) · 34.8 KB
/
Coord.html
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Jun 26 01:31:49 EDT 2014 -->
<title>Coord</title>
<meta name="date" content="2014-06-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Coord";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="index.html?Coord.html" target="_top">Frames</a></li>
<li><a href="Coord.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h2 title="Class Coord" class="title">Class Coord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>Coord</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Coord</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A class to describe a two or three dimensional vector.
<p>
The result of all functions are applied to the vector itself, with the
exception of cross(), which returns a new Coord (or writes to a specified
'target' Coord). That is, add() will add the contents of one vector to
this one. Using add() with additional parameters allows you to put the
result into a new Coord. Functions that act on multiple vectors also
include static versions. Because creating new objects can be computationally
expensive, most functions include an optional 'target' Coord, so that a
new Coord object is not created with each operation.
<p>
Initially based on the Vector3D class by <a href="http://www.shiffman.net">Dan Shiffman</a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="serialized-form.html#Coord">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int[]</code></td>
<td class="colLast"><code><strong><a href="Coord.html#array">array</a></strong></code>
<div class="block">Array so that this can be temporarily used in an array context</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="Coord.html#x">x</a></strong></code>
<div class="block">The x component of the vector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="Coord.html#y">y</a></strong></code>
<div class="block">The y component of the vector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="Coord.html#z">z</a></strong></code>
<div class="block">The z component of the vector.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="Coord.html#Coord()">Coord</a></strong>()</code>
<div class="block">Constructor for an empty vector: x, y, and z are set to 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="Coord.html#Coord(int, int)">Coord</a></strong>(int x,
int y)</code>
<div class="block">Constructor for a 2D vector: z coordinate is set to 0.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="Coord.html#Coord(int, int, int)">Coord</a></strong>(int x,
int y,
int z)</code>
<div class="block">Constructor for a 3D vector.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#add(Coord)">add</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</code>
<div class="block">Add a vector to this vector</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#add(Coord, Coord)">add</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</code>
<div class="block">Add two vectors</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#add(Coord, Coord, Coord)">add</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code>
<div class="block">Add two vectors into a target vector</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#add(int, int, int)">add</a></strong>(int x,
int y,
int z)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><strong><a href="Coord.html#array()">array</a></strong>()</code>
<div class="block">Return a representation of this vector as a int array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(Coord)">div</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</code>
<div class="block">Divide each element of one vector by the elements of another vector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(Coord, Coord)">div</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</code>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and return the result as a new Coord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(Coord, Coord, Coord)">div</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code>
<div class="block">Divide each element of one vector by the individual elements of another
vector, and write the result into a target vector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(Coord, int)">div</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n)</code>
<div class="block">Divide a vector by a scalar and return the result in a new vector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(Coord, int, Coord)">div</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#div(int)">div</a></strong>(int n)</code>
<div class="block">Divide this vector by a scalar</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="Coord.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#get()">get</a></strong>()</code>
<div class="block">Get a copy of this vector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><strong><a href="Coord.html#get(int[])">get</a></strong>(int[] target)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="Coord.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(Coord)">mult</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</code>
<div class="block">Multiply each element of one vector by the elements of another vector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(Coord, Coord)">mult</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</code>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and return the result as a new Coord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(Coord, Coord, Coord)">mult</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and write the result into a target vector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(Coord, int)">mult</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n)</code>
<div class="block">Multiply a vector by a scalar</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(Coord, int, Coord)">mult</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code>
<div class="block">Multiply a vector by a scalar, and write the result into a target Coord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#mult(int)">mult</a></strong>(int n)</code>
<div class="block">Multiply this vector by a scalar</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>PVector</code></td>
<td class="colLast"><code><strong><a href="Coord.html#pvec()">pvec</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#set(Coord)">set</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</code>
<div class="block">Set x, y, and z coordinates from a Vector3D object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#set(int[])">set</a></strong>(int[] source)</code>
<div class="block">Set the x, y (and maybe z) coordinates using a int[] array as the source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#set(int, int, int)">set</a></strong>(int x,
int y,
int z)</code>
<div class="block">Set x, y, and z coordinates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#sub(Coord)">sub</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</code>
<div class="block">Subtract a vector from this vector</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#sub(Coord, Coord)">sub</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</code>
<div class="block">Subtract one vector from another</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Coord.html" title="class in <Unnamed>">Coord</a></code></td>
<td class="colLast"><code><strong><a href="Coord.html#sub(Coord, Coord, Coord)">sub</a></strong>(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#sub(int, int, int)">sub</a></strong>(int x,
int y,
int z)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="Coord.html#toString()">toString</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="Coord.html#wrap(int)">wrap</a></strong>(int n)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="x">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>x</h4>
<pre>public int x</pre>
<div class="block">The x component of the vector.</div>
</li>
</ul>
<a name="y">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>y</h4>
<pre>public int y</pre>
<div class="block">The y component of the vector.</div>
</li>
</ul>
<a name="z">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>z</h4>
<pre>public int z</pre>
<div class="block">The z component of the vector.</div>
</li>
</ul>
<a name="array">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>array</h4>
<pre>protected transient int[] array</pre>
<div class="block">Array so that this can be temporarily used in an array context</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Coord()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Coord</h4>
<pre>public Coord()</pre>
<div class="block">Constructor for an empty vector: x, y, and z are set to 0.</div>
</li>
</ul>
<a name="Coord(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Coord</h4>
<pre>public Coord(int x,
int y,
int z)</pre>
<div class="block">Constructor for a 3D vector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the x coordinate.</dd><dd><code>y</code> - the y coordinate.</dd><dd><code>z</code> - the y coordinate.</dd></dl>
</li>
</ul>
<a name="Coord(int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Coord</h4>
<pre>public Coord(int x,
int y)</pre>
<div class="block">Constructor for a 2D vector: z coordinate is set to 0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the x coordinate.</dd><dd><code>y</code> - the y coordinate.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="wrap(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrap</h4>
<pre>public void wrap(int n)</pre>
</li>
</ul>
<a name="set(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public void set(int x,
int y,
int z)</pre>
<div class="block">Set x, y, and z coordinates.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the x coordinate.</dd><dd><code>y</code> - the y coordinate.</dd><dd><code>z</code> - the z coordinate.</dd></dl>
</li>
</ul>
<a name="set(Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public void set(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</pre>
<div class="block">Set x, y, and z coordinates from a Vector3D object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the Coord object to be copied</dd></dl>
</li>
</ul>
<a name="set(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public void set(int[] source)</pre>
<div class="block">Set the x, y (and maybe z) coordinates using a int[] array as the source.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - array to copy from</dd></dl>
</li>
</ul>
<a name="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="Coord.html" title="class in <Unnamed>">Coord</a> get()</pre>
<div class="block">Get a copy of this vector.</div>
</li>
</ul>
<a name="get(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public int[] get(int[] target)</pre>
</li>
</ul>
<a name="add(Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</pre>
<div class="block">Add a vector to this vector</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the vector to be added</dd></dl>
</li>
</ul>
<a name="add(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(int x,
int y,
int z)</pre>
</li>
</ul>
<a name="add(Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> add(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</pre>
<div class="block">Add two vectors</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - a vector</dd><dd><code>v2</code> - another vector</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new vector that is the sum of v1 and v2</dd></dl>
</li>
</ul>
<a name="pvec()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pvec</h4>
<pre>public PVector pvec()</pre>
</li>
</ul>
<a name="add(Coord, Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> add(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
<div class="block">Add two vectors into a target vector</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - a vector</dd><dd><code>v2</code> - another vector</dd><dd><code>target</code> - the target vector (if null, a new vector will be created)</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new vector that is the sum of v1 and v2</dd></dl>
</li>
</ul>
<a name="sub(Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub</h4>
<pre>public void sub(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</pre>
<div class="block">Subtract a vector from this vector</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the vector to be subtracted</dd></dl>
</li>
</ul>
<a name="sub(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub</h4>
<pre>public void sub(int x,
int y,
int z)</pre>
</li>
</ul>
<a name="sub(Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> sub(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</pre>
<div class="block">Subtract one vector from another</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - a vector</dd><dd><code>v2</code> - another vector</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new vector that is v1 - v2</dd></dl>
</li>
</ul>
<a name="sub(Coord, Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> sub(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
</li>
</ul>
<a name="mult(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public void mult(int n)</pre>
<div class="block">Multiply this vector by a scalar</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the value to multiply by</dd></dl>
</li>
</ul>
<a name="mult(Coord, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> mult(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n)</pre>
<div class="block">Multiply a vector by a scalar</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - a vector</dd><dd><code>n</code> - scalar</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new vector that is v1 * n</dd></dl>
</li>
</ul>
<a name="mult(Coord, int, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> mult(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
<div class="block">Multiply a vector by a scalar, and write the result into a target Coord.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - a vector</dd><dd><code>n</code> - scalar</dd><dd><code>target</code> - Coord to store the result</dd>
<dt><span class="strong">Returns:</span></dt><dd>the target vector, now set to v1 * n</dd></dl>
</li>
</ul>
<a name="mult(Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public void mult(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</pre>
<div class="block">Multiply each element of one vector by the elements of another vector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the vector to multiply by</dd></dl>
</li>
</ul>
<a name="mult(Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> mult(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</pre>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and return the result as a new Coord.</div>
</li>
</ul>
<a name="mult(Coord, Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mult</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> mult(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and write the result into a target vector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - the first vector</dd><dd><code>v2</code> - the second vector</dd><dd><code>target</code> - Coord to store the result</dd></dl>
</li>
</ul>
<a name="div(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public void div(int n)</pre>
<div class="block">Divide this vector by a scalar</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the value to divide by</dd></dl>
</li>
</ul>
<a name="div(Coord, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> div(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n)</pre>
<div class="block">Divide a vector by a scalar and return the result in a new vector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - a vector</dd><dd><code>n</code> - scalar</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new vector that is v1 / n</dd></dl>
</li>
</ul>
<a name="div(Coord, int, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> div(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v,
int n,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
</li>
</ul>
<a name="div(Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public void div(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v)</pre>
<div class="block">Divide each element of one vector by the elements of another vector.</div>
</li>
</ul>
<a name="div(Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> div(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2)</pre>
<div class="block">Multiply each element of one vector by the individual elements of another
vector, and return the result as a new Coord.</div>
</li>
</ul>
<a name="div(Coord, Coord, Coord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public static <a href="Coord.html" title="class in <Unnamed>">Coord</a> div(<a href="Coord.html" title="class in <Unnamed>">Coord</a> v1,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> v2,
<a href="Coord.html" title="class in <Unnamed>">Coord</a> target)</pre>
<div class="block">Divide each element of one vector by the individual elements of another
vector, and write the result into a target vector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - the first vector</dd><dd><code>v2</code> - the second vector</dd><dd><code>target</code> - Coord to store the result</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="array()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>array</h4>
<pre>public int[] array()</pre>
<div class="block">Return a representation of this vector as a int array. This is only for
temporary use. If used in any other fashion, the contents should be copied
by using the get() command to copy into your own array.</div>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="index.html?Coord.html" target="_top">Frames</a></li>
<li><a href="Coord.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>