FFaVec3.H

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 SAP SE
//
// SPDX-License-Identifier: Apache-2.0
//
// This file is part of FEDEM - https://openfedem.org
 
#ifndef FFA_VEC3_H
#define FFA_VEC3_H
 
#include <iostream>
#include <cmath>
 
 
enum FFaVec3IdxEnum
{
  VX, 
  VY, 
  VZ, 
  VW  
};
 
 
class FaVec3
{
public:
  FaVec3() { this->clear(); }
  FaVec3(double x, double y, double z) { n[VX] = x; n[VY] = y; n[VZ] = z; }
  FaVec3(const double* v) { n[VX] = v[VX];   n[VY] = v[VY];   n[VZ] = v[VZ]; }
  FaVec3(const float* v)  { n[VX] = v[VX];   n[VY] = v[VY];   n[VZ] = v[VZ]; }
  FaVec3(const FaVec3& v) { n[VX] = v.n[VX]; n[VY] = v.n[VY]; n[VZ] = v.n[VZ]; }
  virtual ~FaVec3() {}
 
  FaVec3& operator=  (const FaVec3& v);
  FaVec3& operator+= (const FaVec3& v);
  FaVec3& operator-= (const FaVec3& v);
  FaVec3& operator*= (double d);
  FaVec3& operator/= (double d);
 
  const double* getPt() const { return n; }
  double*       getPt()       { return n; }
 
  const double& operator[] (int i) const;
  double&       operator[] (int i);
 
  const double& operator() (int i) const;
  double&       operator() (int i);
 
  double x() const { return n[VX]; }
  double y() const { return n[VY]; }
  double z() const { return n[VZ]; }
 
  void x(double v) { n[VX] = v; }
  void y(double v) { n[VY] = v; }
  void z(double v) { n[VZ] = v; }
  void clear() { n[VX] = n[VY] = n[VZ] = 0.0; }
 
  int isParallell (const FaVec3& otherVec, double tolerance = 1.0e-10) const;
  bool equals     (const FaVec3& otherVec, double tolerance = 0.0) const;
  double angle    (const FaVec3& otherVec) const;
  bool isZero     (double tolerance = 1.0e-10) const;
 
  double sqrLength() const { return n[VX]*n[VX] + n[VY]*n[VY] + n[VZ]*n[VZ]; }
  double length() const { return sqrt(this->sqrLength()); }
 
  FaVec3& truncate(double tolerance = 1.0e-10);
  FaVec3& normalize(double truncTol = 0.0);
  FaVec3& round(int precision);
 
  FaVec3& setByCylCoords(const FaVec3& cylCoords, FFaVec3IdxEnum axis = VZ);
  FaVec3  getAsCylCoords(FFaVec3IdxEnum axis = VZ) const;
 
  FaVec3& setBySphCoords(const FaVec3& sphCoords, FFaVec3IdxEnum axis = VZ);
  FaVec3  getAsSphCoords(FFaVec3IdxEnum axis = VZ) const;
 
  friend FaVec3   operator-  (const FaVec3& v);
  friend FaVec3   operator+  (const FaVec3& a, const FaVec3& b);
  friend FaVec3   operator-  (const FaVec3& a, const FaVec3& b);
  friend FaVec3   operator*  (const FaVec3& a,       double  d);
  friend FaVec3   operator*  (      double  d, const FaVec3& a);
  friend FaVec3   operator/  (const FaVec3& a,       double  d);
  friend double   operator*  (const FaVec3& a, const FaVec3& b);
  friend FaVec3   operator^  (const FaVec3& a, const FaVec3& b);
  friend bool     operator== (const FaVec3& a, const FaVec3& b);
  friend bool     operator!= (const FaVec3& a, const FaVec3& b);
 
  friend std::ostream& operator<< (std::ostream& s, const FaVec3& v);
  friend std::istream& operator>> (std::istream& s, FaVec3& v);
 
private:
  double n[3]; 
};
 
 
// --- inline functions ---
 
inline FaVec3& FaVec3::operator= (const FaVec3& v)
{
  if (this != &v)
    for (int i = 0; i < 3; i++)
      n[i] = v.n[i];
 
  return *this;
}
 
inline const double& FaVec3::operator[] (int i) const
{
#ifdef FFA_INDEXCHECK
  if (i < 0 || i > 2)
    std::cerr <<"FaVec3::operator[]: index i="<< i <<" is out of range [0,2]"
              << std::endl;
#endif
  return n[i];
}
 
inline double& FaVec3::operator[] (int i)
{
#ifdef FFA_INDEXCHECK
  if (i < 0 || i > 2)
    std::cerr <<"FaVec3::operator[]: index i="<< i <<" is out of range [0,2]"
              << std::endl;
#endif
  return n[i];
}
 
inline const double& FaVec3::operator() (int i) const
{
#ifdef FFA_INDEXCHECK
  if (i < 1 || i > 3)
    std::cerr <<"FaVec3::operator(): index i="<< i <<" is out of range [1,3]"
              << std::endl;
#endif
  return n[i-1];
}
 
inline double& FaVec3::operator() (int i)
{
#ifdef FFA_INDEXCHECK
  if (i < 1 || i > 3)
    std::cerr <<"FaVec3::operator(): index i="<< i <<" is out of range [1,3]"
              << std::endl;
#endif
  return n[i-1];
}
 
#endif