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

  Program:   Visualization Toolkit
  Module:    vtkLinearTransform.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/**
 * @class   vtkLinearTransform
 * @brief   abstract superclass for linear transformations
 *
 * vtkLinearTransform provides a generic interface for linear
 * (affine or 12 degree-of-freedom) geometric transformations.
 * @sa
 * vtkTransform vtkIdentityTransform
*/

#ifndef vtkLinearTransform_h
#define vtkLinearTransform_h

#include "vtkCommonTransformsModule.h" // For export macro
#include "vtkHomogeneousTransform.h"

class VTKCOMMONTRANSFORMS_EXPORT vtkLinearTransform : public vtkHomogeneousTransform
{
public:

  vtkTypeMacro(vtkLinearTransform,vtkHomogeneousTransform);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * Apply the transformation to a normal.
   * You can use the same array to store both the input and output.
   */
  void TransformNormal(const float in[3], float out[3]) {
    this->Update(); this->InternalTransformNormal(in,out); };

  /**
   * Apply the transformation to a double-precision normal.
   * You can use the same array to store both the input and output.
   */
  void TransformNormal(const double in[3], double out[3]) {
    this->Update(); this->InternalTransformNormal(in,out); };

  /**
   * Synonymous with TransformDoubleNormal(x,y,z).
   * Use this if you are programming in python or Java.
   */
  double *TransformNormal(double x, double y, double z) VTK_SIZEHINT(3) {
    return this->TransformDoubleNormal(x,y,z); }
  double *TransformNormal(const double normal[3]) VTK_SIZEHINT(3) {
    return this->TransformDoubleNormal(normal[0],normal[1],normal[2]); };

  //@{
  /**
   * Apply the transformation to an (x,y,z) normal.
   * Use this if you are programming in python or Java.
   */
  float *TransformFloatNormal(float x, float y, float z) VTK_SIZEHINT(3) {
    this->InternalFloatPoint[0] = x;
    this->InternalFloatPoint[1] = y;
    this->InternalFloatPoint[2] = z;
    this->TransformNormal(this->InternalFloatPoint,this->InternalFloatPoint);
    return this->InternalFloatPoint; };
  float *TransformFloatNormal(const float normal[3]) VTK_SIZEHINT(3) {
    return this->TransformFloatNormal(normal[0],normal[1],normal[2]); };
  //@}

  //@{
  /**
   * Apply the transformation to a double-precision (x,y,z) normal.
   * Use this if you are programming in python or Java.
   */
  double *TransformDoubleNormal(double x, double y, double z) VTK_SIZEHINT(3) {
    this->InternalDoublePoint[0] = x;
    this->InternalDoublePoint[1] = y;
    this->InternalDoublePoint[2] = z;
    this->TransformNormal(this->InternalDoublePoint,this->InternalDoublePoint);
    return this->InternalDoublePoint; };
  double *TransformDoubleNormal(const double normal[3]) VTK_SIZEHINT(3) {
    return this->TransformDoubleNormal(normal[0],normal[1],normal[2]); };
  //@}

  /**
   * Synonymous with TransformDoubleVector(x,y,z).
   * Use this if you are programming in python or Java.
   */
  double *TransformVector(double x, double y, double z) VTK_SIZEHINT(3) {
    return this->TransformDoubleVector(x,y,z); }
  double *TransformVector(const double normal[3]) VTK_SIZEHINT(3) {
    return this->TransformDoubleVector(normal[0],normal[1],normal[2]); };

  /**
   * Apply the transformation to a vector.
   * You can use the same array to store both the input and output.
   */
  void TransformVector(const float in[3], float out[3]) {
    this->Update(); this->InternalTransformVector(in,out); };

  /**
   * Apply the transformation to a double-precision vector.
   * You can use the same array to store both the input and output.
   */
  void TransformVector(const double in[3], double out[3]) {
    this->Update(); this->InternalTransformVector(in,out); };

  //@{
  /**
   * Apply the transformation to an (x,y,z) vector.
   * Use this if you are programming in python or Java.
   */
  float *TransformFloatVector(float x, float y, float z) VTK_SIZEHINT(3) {
      this->InternalFloatPoint[0] = x;
      this->InternalFloatPoint[1] = y;
      this->InternalFloatPoint[2] = z;
      this->TransformVector(this->InternalFloatPoint,this->InternalFloatPoint);
      return this->InternalFloatPoint; };
  float *TransformFloatVector(const float vec[3]) VTK_SIZEHINT(3) {
    return this->TransformFloatVector(vec[0],vec[1],vec[2]); };
  //@}

  //@{
  /**
   * Apply the transformation to a double-precision (x,y,z) vector.
   * Use this if you are programming in python or Java.
   */
  double *TransformDoubleVector(double x, double y, double z) VTK_SIZEHINT(3) {
    this->InternalDoublePoint[0] = x;
    this->InternalDoublePoint[1] = y;
    this->InternalDoublePoint[2] = z;
    this->TransformVector(this->InternalDoublePoint,this->InternalDoublePoint);
    return this->InternalDoublePoint; };
  double *TransformDoubleVector(const double vec[3]) VTK_SIZEHINT(3) {
    return this->TransformDoubleVector(vec[0],vec[1],vec[2]); };
  //@}

  /**
   * Apply the transformation to a series of points, and append the
   * results to outPts.
   */
  void TransformPoints(vtkPoints *inPts, vtkPoints *outPts) override;

  /**
   * Apply the transformation to a series of normals, and append the
   * results to outNms.
   */
  virtual void TransformNormals(vtkDataArray *inNms, vtkDataArray *outNms);

  /**
   * Apply the transformation to a series of vectors, and append the
   * results to outVrs.
   */
  virtual void TransformVectors(vtkDataArray *inVrs, vtkDataArray *outVrs);

  /**
   * Apply the transformation to a combination of points, normals
   * and vectors.
   */
  void TransformPointsNormalsVectors(vtkPoints *inPts,
                                     vtkPoints *outPts,
                                     vtkDataArray *inNms,
                                     vtkDataArray *outNms,
                                     vtkDataArray *inVrs,
                                     vtkDataArray *outVrs,
                                     int nOptionalVectors = 0,
                                     vtkDataArray** inVrsArr = nullptr,
                                     vtkDataArray** outVrsArr = nullptr) override;

  /**
   * Just like GetInverse, but it includes a typecast to
   * vtkLinearTransform.
   */
  vtkLinearTransform *GetLinearInverse()
  {
      return static_cast<vtkLinearTransform *>(this->GetInverse());
  }

  //@{
  /**
   * This will calculate the transformation without calling Update.
   * Meant for use only within other VTK classes.
   */
  void InternalTransformPoint(const float in[3], float out[3]) override;
  void InternalTransformPoint(const double in[3], double out[3]) override;
  //@}

  //@{
  /**
   * This will calculate the transformation without calling Update.
   * Meant for use only within other VTK classes.
   */
  virtual void InternalTransformNormal(const float in[3], float out[3]);
  virtual void InternalTransformNormal(const double in[3], double out[3]);
  //@}

  //@{
  /**
   * This will calculate the transformation without calling Update.
   * Meant for use only within other VTK classes.
   */
  virtual void InternalTransformVector(const float in[3], float out[3]);
  virtual void InternalTransformVector(const double in[3], double out[3]);
  //@}

  //@{
  /**
   * This will calculate the transformation as well as its derivative
   * without calling Update.  Meant for use only within other VTK
   * classes.
   */
  void InternalTransformDerivative(const float in[3], float out[3],
                                   float derivative[3][3]) override;
  void InternalTransformDerivative(const double in[3], double out[3],
                                   double derivative[3][3]) override;
  //@}

protected:
  vtkLinearTransform() {}
  ~vtkLinearTransform() override {}
private:
  vtkLinearTransform(const vtkLinearTransform&) = delete;
  void operator=(const vtkLinearTransform&) = delete;
};

#endif





