javax.vecmath/src/javax/vecmath/Vector3d.java

   1 /*
   2  * $RCSfile: Vector3d.java,v $
   3  *
   4  * Copyright 1997-2008 Sun Microsystems, Inc.  All Rights Reserved.
   5  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   6  *
   7  * This code is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License version 2 only, as
   9  * published by the Free Software Foundation.  Sun designates this
  10  * particular file as subject to the "Classpath" exception as provided
  11  * by Sun in the LICENSE file that accompanied this code.
  12  *
  13  * This code is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * version 2 for more details (a copy is included in the LICENSE file that
  17  * accompanied this code).
  18  *
  19  * You should have received a copy of the GNU General Public License version
  20  * 2 along with this work; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  22  *
  23  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  24  * CA 95054 USA or visit www.sun.com if you need additional information or
  25  * have any questions.
  26  *
  27  * $Revision: 1.5 $
  28  * $Date: 2008/02/28 20:18:51 $
  29  * $State: Exp $
  30  */
  31
  32 package javax.vecmath;
  33
  34 import java.lang.Math;
  35
  36 /**
  37  * A 3-element vector that is represented by double-precision floating point
  38  * x,y,z coordinates.  If this value represents a normal, then it should
  39  * be normalized.
  40  *
  41  */
  42 public class Vector3d extends Tuple3d implements java.io.Serializable {
  43
  44     // Combatible with 1.1
  45     static final long serialVersionUID = 3761969948420550442L;
  46
  47     /**
  48      * Constructs and initializes a Vector3d from the specified xyz coordinates.
  49      * @param x the x coordinate
  50      * @param y the y coordinate
  51      * @param z the z coordinate
  52      */
  53     public Vector3d(double x, double y, double z)
  54     {
  55         super(x,y,z);
  56     }
  57
  58
  59     /**
  60      * Constructs and initializes a Vector3d from the array of length 3.
  61      * @param v the array of length 3 containing xyz in order
  62      */
  63     public Vector3d(double[] v)
  64     {
  65        super(v);
  66     }
  67
  68
  69     /**
  70      * Constructs and initializes a Vector3d from the specified Vector3d.
  71      * @param v1 the Vector3d containing the initialization x y z data
  72      */
  73     public Vector3d(Vector3d v1)
  74     {
  75          super(v1);
  76     }
  77
  78
  79     /**
  80      * Constructs and initializes a Vector3d from the specified Vector3f.
  81      * @param v1 the Vector3f containing the initialization x y z data
  82      */
  83     public Vector3d(Vector3f v1)
  84     {
  85        super(v1);
  86     }
  87
  88
  89     /**
  90      * Constructs and initializes a Vector3d from the specified Tuple3f.
  91      * @param t1 the Tuple3f containing the initialization x y z data
  92      */
  93     public Vector3d(Tuple3f t1)
  94     {
  95        super(t1);
  96     }
  97
  98
  99     /**
 100      * Constructs and initializes a Vector3d from the specified Tuple3d.
 101      * @param t1 the Tuple3d containing the initialization x y z data
 102      */
 103     public Vector3d(Tuple3d t1)
 104     {
 105        super(t1);
 106     }
 107
 108
 109     /**
 110      * Constructs and initializes a Vector3d to (0,0,0).
 111      */
 112     public Vector3d()
 113     {
 114        super();
 115     }
 116
 117
 118    /**
 119      * Sets this vector to the vector cross product of vectors v1 and v2.
 120      * @param v1 the first vector
 121      * @param v2 the second vector
 122      */
 123     public final void cross(Vector3d v1, Vector3d v2)
 124     {
 125         double x,y;
 126
 127         x = v1.y*v2.z - v1.z*v2.y;
 128         y = v2.x*v1.z - v2.z*v1.x;
 129         this.z = v1.x*v2.y - v1.y*v2.x;
 130         this.x = x;
 131         this.y = y;
 132     }
 133
 134
 135     /**
 136      * Sets the value of this vector to the normalization of vector v1.
 137      * @param v1 the un-normalized vector
 138      */
 139     public final void normalize(Vector3d v1)
 140     {
 141         double norm;
 142
 143         norm = 1.0/Math.sqrt(v1.x*v1.x + v1.y*v1.y + v1.z*v1.z);
 144         this.x = v1.x*norm;
 145         this.y = v1.y*norm;
 146         this.z = v1.z*norm;
 147     }
 148
 149
 150     /**
 151      * Normalizes this vector in place.
 152      */
 153     public final void normalize()
 154     {
 155         double norm;
 156
 157         norm = 1.0/Math.sqrt(this.x*this.x + this.y*this.y + this.z*this.z);
 158         this.x *= norm;
 159         this.y *= norm;
 160         this.z *= norm;
 161     }
 162
 163
 164   /**
 165    * Returns the dot product of this vector and vector v1.
 166    * @param v1 the other vector
 167    * @return the dot product of this and v1
 168    */
 169   public final double dot(Vector3d v1)
 170     {
 171       return (this.x*v1.x + this.y*v1.y + this.z*v1.z);
 172     }
 173
 174
 175     /**
 176      * Returns the squared length of this vector.
 177      * @return the squared length of this vector
 178      */
 179     public final double lengthSquared()
 180     {
 181         return (this.x*this.x + this.y*this.y + this.z*this.z);
 182     }
 183
 184
 185     /**
 186      * Returns the length of this vector.
 187      * @return the length of this vector
 188      */
 189     public final double length()
 190     {
 191         return Math.sqrt(this.x*this.x + this.y*this.y + this.z*this.z);
 192     }
 193
 194
 195   /**
 196     *   Returns the angle in radians between this vector and the vector
 197     *   parameter; the return value is constrained to the range [0,PI].
 198     *   @param v1    the other vector
 199     *   @return   the angle in radians in the range [0,PI]
 200     */
 201    public final double angle(Vector3d v1)
 202    {
 203       double vDot = this.dot(v1) / ( this.length()*v1.length() );
 204       if( vDot < -1.0) vDot = -1.0;
 205       if( vDot >  1.0) vDot =  1.0;
 206       return((double) (Math.acos( vDot )));
 207    }
 208
 209
 210 }