vtkVector.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkVector_h
#define vtkVector_h
 
#include "vtkObject.h" // for legacy macros
#include "vtkTuple.h"
 
#include <cmath> // For math functions
 
VTK_ABI_NAMESPACE_BEGIN
template <typename T, int Size>
class vtkVector : public vtkTuple<T, Size>
{
public:
  vtkVector() = default;

  explicit vtkVector(const T& scalar)
    : vtkTuple<T, Size>(scalar)
  {
  }

  explicit vtkVector(const T* init)
    : vtkTuple<T, Size>(init)
  {
  }


  T SquaredNorm() const
  {
    T result = 0;
    for (int i = 0; i < Size; ++i)
    {
      result += this->Data[i] * this->Data[i];
    }
    return result;
  }


  double Norm() const { return sqrt(static_cast<double>(this->SquaredNorm())); }


  double Normalize()
  {
    const double norm(this->Norm());
    if (norm == 0.0)
    {
      return 0.0;
    }
    const double inv(1.0 / norm);
    for (int i = 0; i < Size; ++i)
    {
      this->Data[i] = static_cast<T>(this->Data[i] * inv);
    }
    return norm;
  }



  vtkVector<T, Size> Normalized() const
  {
    vtkVector<T, Size> temp(*this);
    temp.Normalize();
    return temp;
  }



  T Dot(const vtkVector<T, Size>& other) const
  {
    T result(0);
    for (int i = 0; i < Size; ++i)
    {
      result += this->Data[i] * other[i];
    }
    return result;
  }



  template <typename TR>
  vtkVector<TR, Size> Cast() const
  {
    vtkVector<TR, Size> result;
    for (int i = 0; i < Size; ++i)
    {
      result[i] = static_cast<TR>(this->Data[i]);
    }
    return result;
  }

};
 
// .NAME vtkVector2 - templated base type for storage of 2D vectors.
//
template <typename T>
class vtkVector2 : public vtkVector<T, 2>
{
public:
  vtkVector2() = default;
 
  explicit vtkVector2(const T& scalar)
    : vtkVector<T, 2>(scalar)
  {
  }
 
  explicit vtkVector2(const T* init)
    : vtkVector<T, 2>(init)
  {
  }
 
  vtkVector2(const T& x, const T& y)
  {
    this->Data[0] = x;
    this->Data[1] = y;
  }


  void Set(const T& x, const T& y)
  {
    this->Data[0] = x;
    this->Data[1] = y;
  }


  void SetX(const T& x) { this->Data[0] = x; }

  const T& GetX() const { return this->Data[0]; }

  void SetY(const T& y) { this->Data[1] = y; }

  const T& GetY() const { return this->Data[1]; }


  bool operator<(const vtkVector2<T>& v) const
  {
    return (this->Data[0] < v.Data[0]) || (this->Data[0] == v.Data[0] && this->Data[1] < v.Data[1]);
  }

};
 
// .NAME vtkVector3 - templated base type for storage of 3D vectors.
//
template <typename T>
class vtkVector3 : public vtkVector<T, 3>
{
public:
  vtkVector3() = default;
 
  explicit vtkVector3(const T& scalar)
    : vtkVector<T, 3>(scalar)
  {
  }
 
  explicit vtkVector3(const T* init)
    : vtkVector<T, 3>(init)
  {
  }
 
  vtkVector3(const T& x, const T& y, const T& z)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = z;
  }


  void Set(const T& x, const T& y, const T& z)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = z;
  }


  void SetX(const T& x) { this->Data[0] = x; }

  const T& GetX() const { return this->Data[0]; }

  void SetY(const T& y) { this->Data[1] = y; }

  const T& GetY() const { return this->Data[1]; }

  void SetZ(const T& z) { this->Data[2] = z; }

  const T& GetZ() const { return this->Data[2]; }


  vtkVector3<T> Cross(const vtkVector3<T>& other) const
  {
    vtkVector3<T> res;
    res[0] = this->Data[1] * other.Data[2] - this->Data[2] * other.Data[1];
    res[1] = this->Data[2] * other.Data[0] - this->Data[0] * other.Data[2];
    res[2] = this->Data[0] * other.Data[1] - this->Data[1] * other.Data[0];
    return res;
  }



  bool operator<(const vtkVector3<T>& v) const
  {
    return (this->Data[0] < v.Data[0]) ||
      (this->Data[0] == v.Data[0] && this->Data[1] < v.Data[1]) ||
      (this->Data[0] == v.Data[0] && this->Data[1] == v.Data[1] && this->Data[2] < v.Data[2]);
  }

};
 
// .NAME vtkVector4 - templated base type for storage of 4D vectors.
//
template <typename T>
class vtkVector4 : public vtkVector<T, 4>
{
public:
  vtkVector4() = default;
 
  explicit vtkVector4(const T& scalar)
    : vtkVector<T, 4>(scalar)
  {
  }
 
  explicit vtkVector4(const T* init)
    : vtkVector<T, 4>(init)
  {
  }
 
  vtkVector4(const T& x, const T& y, const T& z, const T& w)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = z;
    this->Data[3] = w;
  }


  void Set(const T& x, const T& y, const T& z, const T& w)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = z;
    this->Data[3] = w;
  }


  void SetX(const T& x) { this->Data[0] = x; }

  const T& GetX() const { return this->Data[0]; }

  void SetY(const T& y) { this->Data[1] = y; }

  const T& GetY() const { return this->Data[1]; }

  void SetZ(const T& z) { this->Data[2] = z; }

  const T& GetZ() const { return this->Data[2]; }

  void SetW(const T& w) { this->Data[3] = w; }

  const T& GetW() const { return this->Data[3]; }
};

#define vtkVectorNormalized(vectorType, type, size)                                                \
  vectorType Normalized() const                                                                    \
  {                                                                                                \
    return vectorType(vtkVector<type, size>::Normalized().GetData());                              \
  }
 
#define vtkVectorDerivedMacro(vectorType, type, size)                                              \
  vtkVectorNormalized(vectorType, type, size);                                                     \
  explicit vectorType(type s)                                                                      \
    : Superclass(s)                                                                                \
  {                                                                                                \
  }                                                                                                \
  explicit vectorType(const type* i)                                                               \
    : Superclass(i)                                                                                \
  {                                                                                                \
  }                                                                                                \
  explicit vectorType(const vtkTuple<type, size>& o)                                               \
    : Superclass(o.GetData())                                                                      \
  {                                                                                                \
  }                                                                                                \
  vectorType(const vtkVector<type, size>& o)                                                       \
    : Superclass(o.GetData())                                                                      \
  {                                                                                                \
  }


class vtkVector2i : public vtkVector2<int>
{
public:
  typedef vtkVector2<int> Superclass;
  vtkVector2i() = default;
  vtkVector2i(int x, int y)
    : vtkVector2<int>(x, y)
  {
  }
  vtkVectorDerivedMacro(vtkVector2i, int, 2);
};

 
class vtkVector2f : public vtkVector2<float>
{
public:
  typedef vtkVector2<float> Superclass;
  vtkVector2f() = default;
  vtkVector2f(float x, float y)
    : vtkVector2<float>(x, y)
  {
  }
  vtkVectorDerivedMacro(vtkVector2f, float, 2);
};
 
class vtkVector2d : public vtkVector2<double>
{
public:
  typedef vtkVector2<double> Superclass;
  vtkVector2d() = default;
  vtkVector2d(double x, double y)
    : vtkVector2<double>(x, y)
  {
  }
  vtkVectorDerivedMacro(vtkVector2d, double, 2);
};
 
#define vtkVector3Cross(vectorType, type)                                                          \
  vectorType Cross(const vectorType& other) const                                                  \
  {                                                                                                \
    return vectorType(vtkVector3<type>::Cross(other).GetData());                                   \
  }
 
class vtkVector3i : public vtkVector3<int>
{
public:
  typedef vtkVector3<int> Superclass;
  vtkVector3i() = default;
  vtkVector3i(int x, int y, int z)
    : vtkVector3<int>(x, y, z)
  {
  }
  vtkVectorDerivedMacro(vtkVector3i, int, 3);
  vtkVector3Cross(vtkVector3i, int);
};
 
class vtkVector3f : public vtkVector3<float>
{
public:
  typedef vtkVector3<float> Superclass;
  vtkVector3f() = default;
  vtkVector3f(float x, float y, float z)
    : vtkVector3<float>(x, y, z)
  {
  }
  vtkVectorDerivedMacro(vtkVector3f, float, 3);
  vtkVector3Cross(vtkVector3f, float);
};
 
class vtkVector3d : public vtkVector3<double>
{
public:
  typedef vtkVector3<double> Superclass;
  vtkVector3d() = default;
  vtkVector3d(double x, double y, double z)
    : vtkVector3<double>(x, y, z)
  {
  }
  vtkVectorDerivedMacro(vtkVector3d, double, 3);
  vtkVector3Cross(vtkVector3d, double);
};
 
class vtkVector4i : public vtkVector4<int>
{
public:
  typedef vtkVector4<int> Superclass;
  vtkVector4i() = default;
  vtkVector4i(int x, int y, int z, int w)
    : vtkVector4<int>(x, y, z, w)
  {
  }
  vtkVectorDerivedMacro(vtkVector4i, int, 4);
};
 
class vtkVector4d : public vtkVector4<double>
{
public:
  using Superclass = vtkVector4<double>;
  vtkVector4d() = default;
  vtkVector4d(double x, double y, double z, double w)
    : vtkVector4<double>(x, y, z, w)
  {
  }
  vtkVectorDerivedMacro(vtkVector4d, double, 4);
};


template <typename A, int Size>
vtkVector<A, Size> operator-(const vtkVector<A, Size>& v)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = -v[i];
  }
  return ret;
}

template <typename A, int Size>
vtkVector<A, Size> operator+(const vtkVector<A, Size>& v1, const vtkVector<A, Size>& v2)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = v1[i] + v2[i];
  }
  return ret;
}

template <typename T, int Size>
vtkVector<T, Size>& operator+=(vtkVector<T, Size>& a, const vtkVector<T, Size>& b)
{
  for (int dim = 0; dim < Size; ++dim)
  {
    a[dim] += b[dim];
  }
 
  return a;
}

template <typename T, int Size, typename Scalar>
vtkVector<T, Size>& operator*=(vtkVector<T, Size>& a, Scalar f)
{
  for (int dim = 0; dim < Size; ++dim)
  {
    a[dim] *= f;
  }
 
  return a;
}

template <typename A, int Size>
vtkVector<A, Size> operator-(const vtkVector<A, Size>& v1, const vtkVector<A, Size>& v2)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = v1[i] - v2[i];
  }
  return ret;
}

template <typename T, int Size>
vtkVector<T, Size>& operator-=(vtkVector<T, Size>& a, const vtkVector<T, Size>& b)
{
  for (int dim = 0; dim < Size; ++dim)
  {
    a[dim] -= b[dim];
  }
 
  return a;
}

template <typename A, int Size>
vtkVector<A, Size> operator*(const vtkVector<A, Size>& v1, const vtkVector<A, Size>& v2)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = v1[i] * v2[i];
  }
  return ret;
}

template <typename A, typename B, int Size>
vtkVector<A, Size> operator*(const vtkVector<A, Size>& v1, const B& scalar)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = v1[i] * scalar;
  }
  return ret;
}

template <typename A, int Size>
vtkVector<A, Size> operator/(const vtkVector<A, Size>& v1, const vtkVector<A, Size>& v2)
{
  vtkVector<A, Size> ret;
  for (int i = 0; i < Size; ++i)
  {
    ret[i] = v1[i] / v2[i];
  }
  return ret;
}

#define vtkVectorOperatorNegate(vectorType, type, size)                                            \
  inline vectorType operator-(const vectorType& v)                                                 \
  {                                                                                                \
    return vectorType((-static_cast<vtkVector<type, size>>(v)).GetData());                         \
  }
#define vtkVectorOperatorPlus(vectorType, type, size)                                              \
  inline vectorType operator+(const vectorType& v1, const vectorType& v2)                          \
  {                                                                                                \
    return vectorType(                                                                             \
      (static_cast<vtkVector<type, size>>(v1) + static_cast<vtkVector<type, size>>(v2))            \
        .GetData());                                                                               \
  }
#define vtkVectorOperatorMinus(vectorType, type, size)                                             \
  inline vectorType operator-(const vectorType& v1, const vectorType& v2)                          \
  {                                                                                                \
    return vectorType(                                                                             \
      (static_cast<vtkVector<type, size>>(v1) - static_cast<vtkVector<type, size>>(v2))            \
        .GetData());                                                                               \
  }
#define vtkVectorOperatorMultiply(vectorType, type, size)                                          \
  inline vectorType operator*(const vectorType& v1, const vectorType& v2)                          \
  {                                                                                                \
    return vectorType(                                                                             \
      (static_cast<vtkVector<type, size>>(v1) * static_cast<vtkVector<type, size>>(v2))            \
        .GetData());                                                                               \
  }
#define vtkVectorOperatorMultiplyScalar(vectorType, type, size)                                    \
  template <typename B>                                                                            \
  inline vectorType operator*(const vectorType& v1, const B& scalar)                               \
  {                                                                                                \
    return vectorType((static_cast<vtkVector<type, size>>(v1) * scalar).GetData());                \
  }
#define vtkVectorOperatorMultiplyScalarPre(vectorType, type, size)                                 \
  template <typename B>                                                                            \
  inline vectorType operator*(const B& scalar, const vectorType& v1)                               \
  {                                                                                                \
    return vectorType((static_cast<vtkVector<type, size>>(v1) * scalar).GetData());                \
  }
#define vtkVectorOperatorDivide(vectorType, type, size)                                            \
  inline vectorType operator/(const vectorType& v1, const vectorType& v2)                          \
  {                                                                                                \
    return vectorType(                                                                             \
      (static_cast<vtkVector<type, size>>(v1) / static_cast<vtkVector<type, size>>(v2))            \
        .GetData());                                                                               \
  }
 
#define vtkVectorOperatorMacro(vectorType, type, size)                                             \
  vtkVectorOperatorNegate(vectorType, type, size);                                                 \
  vtkVectorOperatorPlus(vectorType, type, size);                                                   \
  vtkVectorOperatorMinus(vectorType, type, size);                                                  \
  vtkVectorOperatorMultiply(vectorType, type, size);                                               \
  vtkVectorOperatorMultiplyScalar(vectorType, type, size);                                         \
  vtkVectorOperatorMultiplyScalarPre(vectorType, type, size);                                      \
  vtkVectorOperatorDivide(vectorType, type, size)

vtkVectorOperatorMacro(vtkVector2i, int, 2);
vtkVectorOperatorMacro(vtkVector2f, float, 2);
vtkVectorOperatorMacro(vtkVector2d, double, 2);
vtkVectorOperatorMacro(vtkVector3i, int, 3);
vtkVectorOperatorMacro(vtkVector3f, float, 3);
vtkVectorOperatorMacro(vtkVector3d, double, 3);
 
VTK_ABI_NAMESPACE_END
#endif // vtkVector_h
// VTK-HeaderTest-Exclude: vtkVector.h