/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkScalableAffineTransform_h
#define itkScalableAffineTransform_h

#include "itkAffineTransform.h"

namespace itk
{
/**
 * \brief Affine transformation with a specified center of rotation.
 *
 * This class implements an Affine transform in which the rotation center can be explicitly selected.
 *
 * \ingroup ITKTransform
 */

template <typename TParametersValueType = double, unsigned int VDimension = 3>
class ITK_TEMPLATE_EXPORT ScalableAffineTransform : public AffineTransform<TParametersValueType, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalableAffineTransform);

  /** Standard type alias   */
  using Self = ScalableAffineTransform;
  using Superclass = AffineTransform<TParametersValueType, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(ScalableAffineTransform);

  /** New macro for creation of through a Smart Pointer   */
  itkNewMacro(Self);

  /** Dimension of the domain space. */
  static constexpr unsigned int InputSpaceDimension = VDimension;
  static constexpr unsigned int OutputSpaceDimension = VDimension;
  static constexpr unsigned int SpaceDimension = VDimension;
  static constexpr unsigned int ParametersDimension = VDimension * (VDimension + 1);

  /** Types taken from the Superclass */
  using typename Superclass::ParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::FixedParametersValueType;
  using typename Superclass::JacobianType;
  using typename Superclass::JacobianPositionType;
  using typename Superclass::InverseJacobianPositionType;
  using typename Superclass::ScalarType;
  using typename Superclass::InputVectorType;
  using typename Superclass::OutputVectorType;
  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputCovariantVectorType;
  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;
  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  using typename Superclass::MatrixType;
  using typename Superclass::MatrixValueType;
  using typename Superclass::InverseMatrixType;
  using typename Superclass::CenterType;
  using typename Superclass::OffsetType;
  using typename Superclass::TranslationType;

  /** Base inverse transform type. This type should not be changed to the
   * concrete inverse transform type or inheritance would be lost.  */
  using InverseTransformBaseType = typename Superclass::InverseTransformBaseType;
  using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer;

  /** Set the transformation to an Identity.
   * Sets the matrix to identity and the Offset to null. */
  void
  SetIdentity() override;

  /** Set the scale of the transform. */
  virtual void
  SetScale(const InputVectorType & scale);

  virtual void
  SetScaleComponent(const InputVectorType & scale)
  {
    this->SetScale(scale);
  }

  /** Set the scale of the transform. */
  virtual void
  SetScale(const double scale[VDimension]);

  virtual void
  SetScaleComponent(const double scale[VDimension])
  {
    this->SetScale(scale);
  }

  /** Get the scale of the transform */
  /** @ITKStartGrouping */
  [[nodiscard]] virtual const double *
  GetScale() const
  {
    return m_Scale;
  }
  [[nodiscard]] virtual const double *
  GetScaleComponent() const
  {
    return m_Scale;
  }
  /** @ITKEndGrouping */
  /** Get an inverse of the transform. */
  bool
  GetInverse(Self * inverse) const;

  /** Return an inverse of the transform. */
  InverseTransformBasePointer
  GetInverseTransform() const override;

protected:
  /** Construct an ScalableAffineTransform object
   *
   * This method constructs a new AffineTransform object and
   * initializes the matrix and offset parts of the transformation
   * to values specified by the caller.  If the arguments are
   * omitted, then the AffineTransform is initialized to an identity
   * transformation in the appropriate number of dimensions. */
  /** @ITKStartGrouping */
#if !defined(ITK_LEGACY_REMOVE)
  [[deprecated("Removed unused constructor")]] ScalableAffineTransform(const MatrixType &       matrix,
                                                                       const OutputVectorType & offset);
#endif
  ScalableAffineTransform(unsigned int outputSpaceDimension, unsigned int parametersDimension);
  ScalableAffineTransform(unsigned int parametersDimension);
  ScalableAffineTransform();
  /** @ITKEndGrouping */
  /** Compute the transformation matrix. */
  void
  ComputeMatrix() override;

  ~ScalableAffineTransform() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  SetVarScale(const double * scale)
  {
    for (int i = 0; i < InputSpaceDimension; ++i)
    {
      m_Scale[i] = scale[i];
    }
  }

private:
  double          m_Scale[VDimension]{};
  InputVectorType m_MatrixScale{};
}; // class ScalableAffineTransform
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalableAffineTransform.hxx"
#endif

#endif /* itkScalableAffineTransform_h */
