niftkBasicVec3D.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkBasicVec3D_h
#define niftkBasicVec3D_h

#include <math.h>
#include <iostream>

#include "niftkCoreExports.h"

namespace niftk
{


class NIFTKCORE_EXPORT BasicVec3D
{
public:
  BasicVec3D();
  BasicVec3D(float x1, float y1, float z1);
  BasicVec3D(float av[3]);
  BasicVec3D(const BasicVec3D& v);
  virtual ~BasicVec3D() {  };

  BasicVec3D& operator=(const BasicVec3D& v);

  bool operator==(const BasicVec3D& v);
  bool operator!=(const BasicVec3D& v);


  BasicVec3D operator+(float f) const;
  BasicVec3D operator-(float f) const;
  BasicVec3D operator*(float f) const;
  BasicVec3D operator/(float f) const;

  BasicVec3D& operator+=(float f);
  BasicVec3D& operator-=(float f);
  BasicVec3D& operator*=(float f);
  BasicVec3D& operator/=(float f);


  BasicVec3D  operator+ (const BasicVec3D& v) const;
  BasicVec3D& operator+=(const BasicVec3D& v);
  BasicVec3D  operator- (const BasicVec3D& v) const;
  BasicVec3D& operator-=(const BasicVec3D& v);

  BasicVec3D operator-() const;


  friend BasicVec3D operator*(float a, const BasicVec3D& v) { return BasicVec3D (a * v.GetX(), a * v.GetY(), a * v.GetZ()); }
  friend std::ostream& operator<<(std::ostream& os, const BasicVec3D& vo);


  float      Dot(const BasicVec3D& v) const;
  BasicVec3D Cross(const BasicVec3D& v) const;
  BasicVec3D NormalizedCross(const BasicVec3D& v) const;

  float      Dot(const BasicVec3D& v1, const BasicVec3D& v2);
  BasicVec3D Cross(const BasicVec3D& v1, const BasicVec3D& v2);
  BasicVec3D NormalizedCross(const BasicVec3D& v1, const BasicVec3D& v2);

  void  Normalize();
  void  SetZero();
  float SelfDot();
  float Length();

  float Distance(const BasicVec3D& v) const;
  float DistanceSquared(const BasicVec3D& v) const;

  float Distance(const BasicVec3D& v1, const BasicVec3D& v2);
  float DistanceSquared(const BasicVec3D& v1, const BasicVec3D& v2);

  void  SetX(float x) { m_X = x; }
  float GetX() const  { return m_X; }

  void  SetY(float y) { m_Y = y; }
  float GetY() const  { return m_Y; }

  void  SetZ(float z) { m_Z = z; }
  float GetZ() const  { return m_Z; }

private:

  float m_X;
  float m_Y;
  float m_Z;
};

}

#endif