include/opencascade/GC_MakeMirror2d.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _GC_MakeMirror2d_HeaderFile
0018 #define _GC_MakeMirror2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class Geom2d_Transformation;
0025 class gp_Pnt2d;
0026 class gp_Ax2d;
0027 class gp_Lin2d;
0028 class gp_Dir2d;
0029
0030 //! This class implements elementary construction algorithms for
0031 //! symmetric transformations in 2D space about a point, axis, or line.
0032 //! The result is a `Geom2d_Transformation`.
0033 //! A `GC_MakeMirror2d` object provides a framework for:
0034 //! - defining the transformation parameters;
0035 //! - running the construction algorithm;
0036 //! - querying the resulting transformation via `Value()`.
0037 class GC_MakeMirror2d
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Constructs a central symmetry about a point.
0043   //! @param[in] thePoint center point
0044   Standard_EXPORT GC_MakeMirror2d(const gp_Pnt2d& thePoint);
0045
0046   //! Constructs an axial symmetry about an axis.
0047   //! @param[in] theAxis symmetry axis
0048   Standard_EXPORT GC_MakeMirror2d(const gp_Ax2d& theAxis);
0049
0050   //! Constructs an axial symmetry about a line.
0051   //! @param[in] theLine symmetry line
0052   Standard_EXPORT GC_MakeMirror2d(const gp_Lin2d& theLine);
0053
0054   //! Constructs an axial symmetry about a line defined by point and direction.
0055   //! @param[in] thePoint point on symmetry axis
0056   //! @param[in] theDirec symmetry direction
0057   Standard_EXPORT GC_MakeMirror2d(const gp_Pnt2d& thePoint, const gp_Dir2d& theDirec);
0058
0059   //! Returns the constructed transformation.
0060   //! @return resulting transformation
0061   Standard_EXPORT const occ::handle<Geom2d_Transformation>& Value() const;
0062
0063   //! Conversion operator returning the constructed object.
0064   //! @return resulting transformation
0065   operator const occ::handle<Geom2d_Transformation>&() const { return Value(); }
0066
0067 private:
0068   occ::handle<Geom2d_Transformation> TheMirror;
0069 };
0070
0071 #endif // _GC_MakeMirror2d_HeaderFile