include/opencascade/gce_MakeScale2d.hxx

0001 // Created on: 1992-08-26
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_MakeScale2d_HeaderFile
0018 #define _gce_MakeScale2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Trsf2d.hxx>
0025 class gp_Pnt2d;
0026
0027 //! This class implements an elementary construction algorithm for
0028 //! a scaling transformation in 2D space. The result is a gp_Trsf2d transformation.
0029 //! A MakeScale2d object provides a framework for:
0030 //! -   defining the construction of the transformation,
0031 //! -   implementing the construction algorithm, and
0032 //! -   consulting the result.
0033 class gce_MakeScale2d
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Constructs a scaling transformation.
0039   //! @param[in] Point center of scaling
0040   //! @param[in] Scale scale factor
0041   Standard_EXPORT gce_MakeScale2d(const gp_Pnt2d& Point, const double Scale);
0042
0043   //! Returns the constructed transformation.
0044   //! @return resulting transformation
0045   Standard_EXPORT const gp_Trsf2d& Value() const;
0046
0047   //! Alias for Value() returning a copy.
0048   //! @return resulting transformation
0049   gp_Trsf2d Operator() const { return Value(); }
0050
0051   //! Conversion operator returning the constructed transformation.
0052   //! @return resulting transformation
0053   operator gp_Trsf2d() const { return Operator(); }
0054
0055 private:
0056   gp_Trsf2d TheScale2d;
0057 };
0058
0059 #endif // _gce_MakeScale2d_HeaderFile