Vector.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef VECTOR_H
#define VECTOR_H

#include <cmath>
#include <sstream>
#include <iostream>
#include <stdlib.h> 

#include "GeneralDefine.h"

class Vec3D
{
public:
    
    Mdouble X, Y, Z;

    Vec3D();
    
    Vec3D(const Mdouble x, const Mdouble y, const Mdouble z);
    
    void setZero();
    
    bool isZero() const;
    
    Vec3D operator +(const Vec3D& a) const;
    
    Vec3D operator -(const Vec3D& a) const;
    
//    /*!
//     * \brief Adds a scalar
//     */
//    Vec3D operator +(const Mdouble a) const;
//
//    /*!
//     * \brief Subtracts a scalar
//     */
//    Vec3D operator -(const Mdouble a) const;
    
    Vec3D operator *(const Mdouble a) const;
    
    Vec3D operator /(const Mdouble a) const;
    
    Vec3D& operator+=(const Vec3D& a);
    
    Vec3D& operator-=(const Vec3D& a);
    
    Vec3D& operator*=(const Mdouble a);
    
    Vec3D& operator/=(const Mdouble a);
    
    static Mdouble dot(const Vec3D& a, const Vec3D& b);
    
    static Vec3D max(const Vec3D& a, const Vec3D& b);
    
    static Vec3D min(const Vec3D& a, const Vec3D& b);
    
    static Vec3D square(const Vec3D& a);
    
    void normalize();
    
    void setLength(Mdouble length);
    
    static Vec3D sqrt(const Vec3D& a);
    
    static Vec3D cross(const Vec3D& a, const Vec3D& b);
    
    static Mdouble getDistance(const Vec3D& a, const Vec3D& b);
    
    static Mdouble getDistanceSquared(const Vec3D& a, const Vec3D& b);
    
    static Mdouble getLength(const Vec3D& a);

    static Mdouble getLengthSquared(const Vec3D& a);
    
    Mdouble getLength() const;
    
    Mdouble getLengthSquared() const;
    
    Mdouble getComponent(const int index) const;
    
    void setComponent(const int index, const double val);
    
    Vec3D getCylindricalCoordinates() const;
    
    Vec3D getFromCylindricalCoordinates() const;

    bool isEqualTo(const Vec3D& other, const double tol) const;
    
//  void ConvertToCylindricalCoordinates()
//  {
//      double R = sqrt(X*X+Y*Y); Y = atan2(Y,X); X = R; return;
//  }
// 
//  void ConvertFromCylindricalCoordinates()
//  {
//      double Xnew = X * cos(Y); Y = X * sin(Y); X = Xnew; return;
//  }
    
    static Vec3D getUnitVector(const Vec3D& a);
    
    friend std::ostream& operator<<(std::ostream& os, const Vec3D& a);
    
    friend std::istream& operator>>(std::istream& is, Vec3D& a);

    //what a stupid idea! don't implement that!
//    /*!
//     * \brief Adds a scalar to a vector
//     */
//    friend Vec3D operator+(const Mdouble a, const Vec3D& b);
//
//    /*!
//     * \brief Subtracts the elements of a vector from a scalar
//     */
//    friend Vec3D operator-(const Mdouble a, const Vec3D& b);
//
    friend Vec3D operator-(const Vec3D& a);
    
    friend Vec3D operator*(const Mdouble a, const Vec3D& b);    
};

#endif