Merge branch 'Jalview-BH/JAL-3026-JAL-3063-JAXB' of
[jalview.git] / srcjar / javajs / util / T4.java
1 /*
2    Copyright (C) 1997,1998,1999
3    Kenji Hiranabe, Eiwa System Management, Inc.
4
5    This program is free software.
6    Implemented by Kenji Hiranabe(hiranabe@esm.co.jp),
7    conforming to the Java(TM) 3D API specification by Sun Microsystems.
8
9    Permission to use, copy, modify, distribute and sell this software
10    and its documentation for any purpose is hereby granted without fee,
11    provided that the above copyright notice appear in all copies and
12    that both that copyright notice and this permission notice appear
13    in supporting documentation. Kenji Hiranabe and Eiwa System Management,Inc.
14    makes no representations about the suitability of this software for any
15    purpose.  It is provided "AS IS" with NO WARRANTY.
16 */
17 package javajs.util;
18
19 /**
20  * A generic 4 element tuple that is represented by single precision floating
21  * point x,y,z and w coordinates.
22  * 
23  * @version specification 1.1, implementation $Revision: 1.9 $, $Date:
24  *          2006/07/28 17:01:32 $
25  * @author Kenji hiranabe
26  * 
27  * additions by Bob Hanson hansonr@stolaf.edu 9/30/2012
28  * for unique constructor and method names
29  * for the optimization of compiled JavaScript using Java2Script
30  */
31 public abstract class T4 extends T3 {
32
33   /**
34    * The w coordinate.
35    */
36   public float w;
37
38   /**
39    * Constructs and initializes a Tuple4f to (0,0,0,0).
40    * 
41    */
42   public T4() {
43   }
44
45   /**
46    * Sets the value of this tuple to the specified xyzw coordinates.
47    * 
48    * @param x
49    *        the x coordinate
50    * @param y
51    *        the y coordinate
52    * @param z
53    *        the z coordinate
54    * @param w
55    *        the w coordinate
56    */
57   public final void set4(float x, float y, float z, float w) {
58     this.x = x;
59     this.y = y;
60     this.z = z;
61     this.w = w;
62   }
63
64   /**
65    * Sets the value of this tuple to the scalar multiplication of itself.
66    * 
67    * @param s
68    *        the scalar value
69    */
70   public final void scale4(float s) {
71     scale(s);
72     w *= s;
73   }
74
75   /**
76    * Returns a hash number based on the data values in this object. Two
77    * different Tuple4f objects with identical data values (ie, returns true for
78    * equals(Tuple4f) ) will return the same hash number. Two vectors with
79    * different data members may return the same hash value, although this is not
80    * likely.
81    */
82   @Override
83   public int hashCode() {
84     return T3.floatToIntBits(x) ^ T3.floatToIntBits(y)
85         ^ T3.floatToIntBits(z) ^ T3.floatToIntBits(w);
86   }
87
88   /**
89    * Returns true if all of the data members of Object are equal to the
90    * corresponding data members in this
91    * 
92    * @param o
93    *        the vector with which the comparison is made.
94    */
95   @Override
96   public boolean equals(Object o) {
97     if (!(o instanceof T4))
98       return false;
99     T4 t = (T4) o;
100     return (this.x == t.x && this.y == t.y && this.z == t.z && this.w == t.w);
101   }
102
103   /**
104    * Returns a string that contains the values of this Tuple4f. The form is
105    * (x,y,z,w).
106    * 
107    * @return the String representation
108    */
109   @Override
110   public String toString() {
111     return "(" + x + ", " + y + ", " + z + ", " + w + ")";
112   }
113
114   @Override
115   public String toJSON() {
116     return "[" + x + ", " + y + ", " + z + ", " + w + "]";
117   }
118
119 }