include/opencascade/Extrema_POnSurfParams.hxx

0001 // Created on: 2012-12-06
0002 // Created by: Sergey KHROMOV
0003 // Copyright (c) 2004-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _Extrema_POnSurfParams_HeaderFile
0017 #define _Extrema_POnSurfParams_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021
0022 #include <Extrema_ElementType.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <Extrema_POnSurf.hxx>
0025 class gp_Pnt;
0026
0027
0028 //! Data container for point on surface parameters. These parameters
0029 //! are required to compute an initial approximation for extrema
0030 //! computation.
0031 class Extrema_POnSurfParams  : public Extrema_POnSurf
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   //! empty constructor
0039     Extrema_POnSurfParams();
0040
0041   //! Creation of a point on surface with parameter
0042   //! values on the surface and a Pnt from gp.
0043     Extrema_POnSurfParams(const Standard_Real theU, const Standard_Real theV, const gp_Pnt& thePnt);
0044
0045   //! Sets the square distance from this point to another one
0046   //! (e.g. to the point to be projected).
0047     void SetSqrDistance (const Standard_Real theSqrDistance);
0048
0049   //! Query the square distance from this point to another one.
0050     Standard_Real GetSqrDistance() const;
0051
0052   //! Sets the element type on which this point is situated.
0053     void SetElementType (const Extrema_ElementType theElementType);
0054
0055   //! Query the element type on which this point is situated.
0056     Extrema_ElementType GetElementType() const;
0057
0058   //! Sets the U and V indices of an element that contains
0059   //! this point.
0060     void SetIndices (const Standard_Integer theIndexU, const Standard_Integer theIndexV);
0061
0062   //! Query the U and V indices of an element that contains
0063   //! this point.
0064     void GetIndices (Standard_Integer& theIndexU, Standard_Integer& theIndexV) const;
0065
0066
0067
0068
0069 protected:
0070
0071
0072
0073
0074
0075 private:
0076
0077
0078
0079   Standard_Real mySqrDistance;
0080   Extrema_ElementType myElementType;
0081   Standard_Integer myIndexU;
0082   Standard_Integer myIndexV;
0083
0084
0085 };
0086
0087
0088 #include <Extrema_POnSurfParams.lxx>
0089
0090
0091
0092
0093
0094 #endif // _Extrema_POnSurfParams_HeaderFile