/*
* Vector3D.h
*
* Created on: Mar 1, 2011
* Author: Jakob Odersky
*/
#ifndef VECTOR3D_H_
#define VECTOR3D_H_
#include <sstream>
#include <math.h>
#include "exception.h"
#include "Printable.h"
namespace vhc {
/** Un vecteur de dimension trois. Les instances de cette classes sont complètement
* invariables, c'est-à-dire qu'un vecteur une fois initialisé, ses composantes ne
* peuvent plus êtres modifiées.
* Le fait qu'un vecteur ne possède pas d'état, facilite le raisonnement et paraît
* surtout naturel.
* Ainsi, chaque opération sur un vecteur retourne une nouvelle instance. La
* performance ainsi perdue est minimale pour une classe ne contenant que trois
* champs.
* Les méthodes d'un vecteur sont toutes très simples et implémentées dans le header,
* afin d'être développées 'inline' durant la compilation, ce qui est plus rapide.
*/
class Vector3D: public Printable {
private:
/** Composante x. */
double x;
/** Composante y. */
double y;
/** Composante z. */
double z;
/** Cache de norme. (-1 si pas encore calcule) */
mutable double normCache;
public:
/** Crée une nouvelle instance de <code>Vector3D</code>.
* @param _x 1e composante
* @param _y 2e composante
* @param _z 3e composante
*/
Vector3D(double _x, double _y, double _z) : x(_x), y(_y), z(_z), normCache(-1) {};
/** Retourne la composante x de ce vecteur. */
double getX() const {return x;};
/** Retourne la composante y de ce vecteur. */
double getY() const {return y;};
/** Retourne la composante z de ce vecteur. */
double getZ() const {return z;};
/** Vérifie si ce vecteur et le vecteur <code>v</code> sont égaux, i.e. qu'ils ont les mêmes composantes. */
bool operator== (const Vector3D& v) const {return x == v.x && y == v.y && z == v.z;};
/** Vérifie si ce vecteur et le vecteur <code>v</code> sont différents, i.e. qu'ils ont des composantes différentes. */
bool operator!= (const Vector3D& v) const {return !((*this) == (v));};
/** Addition de vecteurs. Retourne un nouveau vecteur résultant de l'addition de ce vecteur avec <code>v</code>. */
Vector3D operator+ (const Vector3D& v) const {return Vector3D(x + v.x, y + v.y, z + v.z);};
/** Multiplication scalaire. Retourne un nouveau vecteur résultant de la multiplication de ce vecteur par <code>n</code>. */
Vector3D operator* (double n) const {return Vector3D(x * n, y * n, z * n);};
/** Retourne l'opposé de ce vecteur. */
Vector3D operator-() const {return (*this) * (-1.0);};
/** Soustraction de vecteurs. Retourne un nouveau vecteur résultant de la soustraction de ce vecteur avec <code>v</code>. */
Vector3D operator- (const Vector3D& v) const {return (*this) + -v;};
/** Division scalaire. Retourne un nouveau vecteur résultant de la division de ce vecteur par <code>n</code>. */
Vector3D operator/ (double n) const {return (*this) * (1.0 / n) ;};
/** Produit scalaire. Retourne le produit scalaire de ce vecteur avec le vecteur <code>v</code>. */
double dot(const Vector3D& v) const {return x * v.x + y * v.y + z * v.z;};
/** Produit vectoriel. Retourne le produit vectoriel direct (main droite) de ce vecteur avec le vecteur <code>v</code>.
* Nous avons decidé de ne pas utiliser l'operateur `^' pour représenter le produit vectoriel car sa précédence est plus
* basse que toutes autres opérations binaires sur les vecteurs.
*/
Vector3D cross(const Vector3D& v) const {return Vector3D(y * v.z - v.y * z, v.x * z - x * v.z, x * v.y - v.x * y);};
/** Vecteur unitaire de ce vecteur. */
Vector3D operator~() const {
if (norm() != 0.0) return (*this) / norm();
else throw UnsupportedOperationException("Zero vector does not have a unit vector.");
};
/** Retourne le vecteur unitaire */
Vector3D unit() const {return ~(*this);}
/** Retourne la norme du vecteur. */
double norm() const {
if (normCache == -1) normCache = sqrt(dot(*this));
return normCache;
}
/** Retourne la norme du vecteur au carre. */
double normSquare() const {return dot(*this);}
/** Retourne une représentation en chaîne de caractères de ce vecteur. */
virtual std::string toString() const {
std::stringstream s;
s << "(" << x << ", " << y << ", " << z << ")";
return s.str();
};
double angle(const Vector3D& v) const {return acos(dot(v) / norm() / v.norm());}
/** Produit mixte de 3 vecteurs. Retourne le produit scalaire de ce vecteur
* avec le produit vectoriel de deux vecteurs <code>v</code> et <code>w</code>). */
double tripleProduct(const Vector3D& v, const Vector3D& w) const { return dot(v.cross(w)); }
/** Rotation vectorielle. Retourne le vecteur courant, évalué dans la formule en <code>a</code>,
* le vecteur de l'axe, et en <code>t</code>, l'angle de rotation. */
Vector3D rotate(const Vector3D& axis, double t) const {
const Vector3D& x = *this;
const Vector3D& a = ~axis;
//cos(t) x + ( 1-cos(t) ) (x*a) a + sin(t) a ^ x
return x * cos(t) + a * x.dot(a) * (1-cos(t)) + a.cross(x) * sin(t);
}
/** Vecteur nul. (0,0,0) */
static const Vector3D Null;
/** Vecteur unitaire, d'axe x. (1, 0, 0) */
static const Vector3D i;
/** Vecteur unitaire, d'axe y. (0, 1, 0) */
static const Vector3D j;
/** Vecteur unitaire, d'axe z. (0, 0, 1) */
static const Vector3D k;
};
/** Surcharge externe de la mutliplication scalaire. */
Vector3D operator* (double n, const Vector3D& v);
} // namespace
#endif /* VECTOR3D_H_ */
