DualQuaternionT.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. 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.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder 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 COPYRIGHT HOLDER *
 * OR CONTRIBUTORS 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.              *
 *                                                                           *
\*===========================================================================*/

//=============================================================================
//
//  CLASS DualQuaternion
//
//=============================================================================

#ifndef ACG_DUALQUATERNION_HH
#define ACG_DUALQUATERNION_HH


//== INCLUDES =================================================================

#include "QuaternionT.hh"


//== NAMESPACES  ==============================================================

namespace ACG {


//== CLASS DEFINITION =========================================================


template <class Scalar>
class DualQuaternionT
{
public:

  typedef QuaternionT<Scalar>      Quaternion;
  typedef DualQuaternionT<Scalar>  DualQuaternion;
  typedef VectorT<Scalar,3>        Vec3;
  typedef VectorT<Scalar,4>        Vec4;
  typedef Matrix4x4T<Scalar>       Matrix;

  Quaternion real_;
  Quaternion dual_;
  
  
  // Constructors
  //
  
  DualQuaternionT();
  
  DualQuaternionT(const DualQuaternion& _other);
  
  DualQuaternionT(const Quaternion& _real, const Quaternion& _dual);
  
  DualQuaternionT(Scalar _Rw, Scalar _Rx, Scalar _Ry, Scalar _Rz,
                  Scalar _Dw, Scalar _Dx, Scalar _Dy, Scalar _Dz);

  DualQuaternionT(Quaternion _rotation);
  
  DualQuaternionT(const Vec3& _translation);
  
  DualQuaternionT(const Vec3& _translation, const Quaternion& _rotation);
  
  DualQuaternionT(const Matrix& _transformation);
  
  // default quaternions
  
  static DualQuaternion identity();

  static DualQuaternion zero();
  
  // Operators
  //
  
  DualQuaternion conjugate() const;

  DualQuaternion invert() const;
  
  void normalize();
  
  bool operator==(const DualQuaternion& _other) const;
  bool operator!=(const DualQuaternion& _other) const;
  
  DualQuaternion operator+(const DualQuaternion& _other) const;
  DualQuaternion& operator+=(const DualQuaternion& _other);
  
  DualQuaternion operator-(const DualQuaternion& _other) const;
  DualQuaternion& operator-=(const DualQuaternion& _other);

  DualQuaternion operator*(const DualQuaternion& _q) const;

  DualQuaternion operator*(const Scalar& _scalar) const;
  
  DualQuaternion& operator*=(const DualQuaternion& _q);

  Scalar& operator [](const unsigned int& b);

  template <typename VectorType>
  static DualQuaternion interpolate(VectorType& _weights, const std::vector<DualQuaternion>& _dualQuaternions);
  
  Vec3 transform_point(const Vec3& _point) const;
  
  Vec3 transform_vector(const Vec3& _point) const;
  
  void printInfo();

};


typedef DualQuaternionT<float>  DualQuaternionf;
typedef DualQuaternionT<double> DualQuaterniond;


//=============================================================================
} // namespace ACG
//=============================================================================
#if defined(INCLUDE_TEMPLATES) && !defined(ACG_DUALQUATERNIONT_C)
#define ACG_QUATERNIONT_TEMPLATES
#include "DualQuaternionT_impl.hh"
#endif
//=============================================================================
#endif // ACG_DUALQUATERNION_HH defined
//=============================================================================