OCCT

// Created on: 1992-09-28
// Created by: Remi GILET
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _GC_MakeRotation_HeaderFile
#define _GC_MakeRotation_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Real.hxx>
class Geom_Transformation;
class gp_Lin;
class gp_Ax1;
class gp_Pnt;
class gp_Dir;

//! This class implements elementary construction algorithms for a
//! rotation in 3D space. The result is a
//! Geom_Transformation transformation.
//! A MakeRotation object provides a framework for:
//! -   defining the construction of the transformation,
//! -   implementing the construction algorithm, and
//! -   consulting the result.
class GC_MakeRotation
{
public:
  DEFINE_STANDARD_ALLOC

  //! Constructs a rotation around the axis defined by a line.
  //! @param[in] theLine rotation axis
  //! @param[in] theAngle rotation angle in radians
  Standard_EXPORT GC_MakeRotation(const gp_Lin& theLine, const double theAngle);

  //! Constructs a rotation around an axis.
  //! @param[in] theAxis rotation axis
  //! @param[in] theAngle rotation angle in radians
  Standard_EXPORT GC_MakeRotation(const gp_Ax1& theAxis, const double theAngle);

  //! Constructs a rotation around an axis defined by point and direction.
  //! @param[in] thePoint point on the axis
  //! @param[in] theDirec axis direction
  //! @param[in] theAngle rotation angle in radians
  Standard_EXPORT GC_MakeRotation(const gp_Pnt& thePoint,
                                  const gp_Dir& theDirec,
                                  const double  theAngle);

  //! Returns the constructed transformation.
  //! @return resulting transformation
  Standard_EXPORT const occ::handle<Geom_Transformation>& Value() const;

  //! Conversion operator returning the constructed object.
  //! @return resulting object
  operator const occ::handle<Geom_Transformation>&() const { return Value(); }

private:
  occ::handle<Geom_Transformation> TheRotation;
};

#endif // _GC_MakeRotation_HeaderFile