include/opencascade/gce_MakeMirror.hxx

0001 // Created on: 1992-09-01
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 _gce_MakeMirror_HeaderFile
0018 #define _gce_MakeMirror_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Trsf.hxx>
0025 class gp_Pnt;
0026 class gp_Ax1;
0027 class gp_Lin;
0028 class gp_Dir;
0029 class gp_Pln;
0030 class gp_Ax2;
0031
0032 //! This class implements elementary construction algorithms for a
0033 //! symmetrical transformation in 3D space about a point,
0034 //! axis or plane. The result is a gp_Trsf transformation.
0035 //! A MakeMirror object provides a framework for:
0036 //! -   defining the construction of the transformation,
0037 //! -   implementing the construction algorithm, and
0038 //! -   consulting the result.
0039 class gce_MakeMirror
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Constructs a central symmetry about a point.
0045   //! @param[in] Point center point
0046   Standard_EXPORT gce_MakeMirror(const gp_Pnt& Point);
0047
0048   //! Constructs an axial symmetry about an axis.
0049   //! @param[in] Axis mirror axis
0050   Standard_EXPORT gce_MakeMirror(const gp_Ax1& Axis);
0051
0052   //! Constructs an axial symmetry about a line.
0053   //! @param[in] Line mirror line
0054   Standard_EXPORT gce_MakeMirror(const gp_Lin& Line);
0055
0056   //! Constructs an axial symmetry about an axis defined by point and direction.
0057   //! @param[in] Point point on the axis
0058   //! @param[in] Direc axis direction
0059   Standard_EXPORT gce_MakeMirror(const gp_Pnt& Point, const gp_Dir& Direc);
0060
0061   //! Constructs a planar symmetry about a plane.
0062   //! @param[in] Plane mirror plane
0063   Standard_EXPORT gce_MakeMirror(const gp_Pln& Plane);
0064
0065   //! Constructs a planar symmetry about a plane.
0066   //! @param[in] Plane mirror plane
0067   Standard_EXPORT gce_MakeMirror(const gp_Ax2& Plane);
0068
0069   //! Returns the constructed transformation.
0070   //! @return resulting transformation
0071   Standard_EXPORT const gp_Trsf& Value() const;
0072
0073   //! Alias for Value() returning a copy.
0074   //! @return resulting transformation
0075   gp_Trsf Operator() const { return Value(); }
0076
0077   //! Conversion operator returning the constructed transformation.
0078   //! @return resulting transformation
0079   operator gp_Trsf() const { return Operator(); }
0080
0081 private:
0082   gp_Trsf TheMirror;
0083 };
0084
0085 #endif // _gce_MakeMirror_HeaderFile