/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkAffineGeometryFrame_h
#define itkAffineGeometryFrame_h

#include "itkObject.h"
#include "itkMacro.h"
#include "itkScalableAffineTransform.h"
#include "itkBoundingBox.h"

namespace itk
{
/** \class AffineGeometryFrame
 * \brief Describes the geometry of a data object
 * \ingroup ITKSpatialObjects
 */
template< typename TScalar = double, unsigned int NDimensions = 3 >
class AffineGeometryFrame:public Object
{
public:
  typedef AffineGeometryFrame        Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef ScalableAffineTransform< TScalar, NDimensions >     TransformType;
  typedef BoundingBox< IdentifierType, NDimensions, TScalar > BoundingBoxType;
  typedef typename BoundingBoxType::BoundsArrayType           BoundsArrayType;
  typedef typename BoundingBoxType::Pointer                   BoundingBoxPointer;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Method for creation through the object factory. */
  itkTypeMacro(AffineGeometryFrame, Object);

  /** Get the bounding box */
  itkGetModifiableObjectMacro(BoundingBox, BoundingBoxType);

  const BoundsArrayType GetBounds() const
  {
    itkAssertInDebugAndIgnoreInReleaseMacro( m_BoundingBox.IsNotNull() );
    return m_BoundingBox->GetBounds();
  }

  /** Set the bounding box Only possible via the BoundsArray
   * to make clear that a copy of the bounding-box is stored,
   * not a reference to it. */
  virtual void SetBounds(const BoundsArrayType & bounds);

  /** Get the extent of the bounding box */
  TScalar GetExtent(unsigned int direction) const
  {
    itkAssertInDebugAndIgnoreInReleaseMacro(direction < NDimensions);
    itkAssertInDebugAndIgnoreInReleaseMacro( m_BoundingBox.IsNotNull() );
    BoundsArrayType bounds = m_BoundingBox->GetBounds();
    return bounds[direction * 2 + 1] - bounds[direction * 2];
  }

  /** Set/Get the IndexToObjectTransform */
  itkSetObjectMacro(IndexToObjectTransform, TransformType);
  itkGetModifiableObjectMacro(IndexToObjectTransform, TransformType);

  /** Set/Get the ObjectToNodeTransform */
  itkSetObjectMacro(ObjectToNodeTransform, TransformType);
  itkGetModifiableObjectMacro(ObjectToNodeTransform, TransformType);

  /** Set/Get the IndexToWorldTransform */
  itkSetObjectMacro(IndexToWorldTransform, TransformType);
  itkGetModifiableObjectMacro(IndexToWorldTransform, TransformType);

  /** Get the IndexToNodeTransform
   *  This Transform cannot be set, and is just computed internally */
  itkGetModifiableObjectMacro(IndexToNodeTransform, TransformType);

  /** Initialize the geometry frame */
  virtual void Initialize();

  /** Clone the geometry frame */
  virtual LightObject::Pointer InternalClone() const ITK_OVERRIDE;

protected:

  AffineGeometryFrame();
  virtual ~AffineGeometryFrame();
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  /** used in clone to initialize the newly created geometry */
  virtual void InitializeGeometry(Self *newGeometry) const;

  void SetBoundsArray(const BoundsArrayType & bounds,
                      BoundingBoxPointer & boundingBox);

  mutable BoundingBoxPointer m_BoundingBox;

  /** Transform from unit coordinates to object coordinates */
  typename TransformType::Pointer m_IndexToObjectTransform;
  typename TransformType::Pointer m_ObjectToNodeTransform;
  typename TransformType::Pointer m_IndexToNodeTransform;
  typename TransformType::Pointer m_IndexToWorldTransform;

private:
  AffineGeometryFrame(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;
};
} // namespace itk

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

#endif /* itkAffineGeometryFrame_h */
