include/opencascade/IntPatch_TheSOnBounds.hxx

0001 // Created on: 1992-05-06
0002 // Created by: Jacques GOUSSARD
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 _IntPatch_TheSOnBounds_HeaderFile
0018 #define _IntPatch_TheSOnBounds_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <IntPatch_TheSegmentOfTheSOnBounds.hxx>
0025 #include <NCollection_Sequence.hxx>
0026 #include <IntPatch_ThePathPointOfTheSOnBounds.hxx>
0027 #include <Standard_Integer.hxx>
0028 class StdFail_NotDone;
0029 class Standard_OutOfRange;
0030 class Standard_ConstructionError;
0031 class Adaptor3d_HVertex;
0032 class IntPatch_HCurve2dTool;
0033 class IntPatch_HInterTool;
0034 class Adaptor3d_TopolTool;
0035 class IntPatch_ArcFunction;
0036 class IntPatch_ThePathPointOfTheSOnBounds;
0037 class IntPatch_TheSegmentOfTheSOnBounds;
0038
0039 class IntPatch_TheSOnBounds
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Empty constructor.
0045   Standard_EXPORT IntPatch_TheSOnBounds();
0046
0047   //! Algorithm to find the points and parts of curves of Domain
0048   //! (domain of of restriction of a surface) which verify
0049   //! F = 0.
0050   //! TolBoundary defines if a curve is on Q.
0051   //! TolTangency defines if a point is on Q.
0052   Standard_EXPORT void Perform(IntPatch_ArcFunction&                   F,
0053                                const occ::handle<Adaptor3d_TopolTool>& Domain,
0054                                const double                            TolBoundary,
0055                                const double                            TolTangency,
0056                                const bool                              RecheckOnRegularity = false);
0057
0058   //! Returns True if the calculus was successful.
0059   bool IsDone() const;
0060
0061   //! Returns true if all arc of the Arcs are solution (inside
0062   //! the surface).
0063   //! An exception is raised if IsDone returns False.
0064   bool AllArcSolution() const;
0065
0066   //! Returns the number of resulting points.
0067   //! An exception is raised if IsDone returns False (NotDone).
0068   int NbPoints() const;
0069
0070   //! Returns the resulting point of range Index.
0071   //! The exception NotDone is raised if IsDone() returns
0072   //! False.
0073   //! The exception OutOfRange is raised if
0074   //! Index <= 0 or Index > NbPoints.
0075   const IntPatch_ThePathPointOfTheSOnBounds& Point(const int Index) const;
0076
0077   //! Returns the number of the resulting segments.
0078   //! An exception is raised if IsDone returns False (NotDone).
0079   int NbSegments() const;
0080
0081   //! Returns the resulting segment of range Index.
0082   //! The exception NotDone is raised if IsDone() returns
0083   //! False.
0084   //! The exception OutOfRange is raised if
0085   //! Index <= 0 or Index > NbPoints.
0086   const IntPatch_TheSegmentOfTheSOnBounds& Segment(const int Index) const;
0087
0088 private:
0089   bool                                                      done;
0090   bool                                                      all;
0091   NCollection_Sequence<IntPatch_TheSegmentOfTheSOnBounds>   sseg;
0092   NCollection_Sequence<IntPatch_ThePathPointOfTheSOnBounds> spnt;
0093 };
0094
0095 #define TheVertex occ::handle<Adaptor3d_HVertex>
0096 #define TheVertex_hxx <Adaptor3d_HVertex.hxx>
0097 #define TheArc occ::handle<Adaptor2d_Curve2d>
0098 #define TheArc_hxx <Adaptor2d_Curve2d.hxx>
0099 #define TheArcTool IntPatch_HCurve2dTool
0100 #define TheArcTool_hxx <IntPatch_HCurve2dTool.hxx>
0101 #define TheSOBTool IntPatch_HInterTool
0102 #define TheSOBTool_hxx <IntPatch_HInterTool.hxx>
0103 #define Handle_TheTopolTool occ::handle<Adaptor3d_TopolTool>
0104 #define TheTopolTool Adaptor3d_TopolTool
0105 #define TheTopolTool_hxx <Adaptor3d_TopolTool.hxx>
0106 #define TheFunction IntPatch_ArcFunction
0107 #define TheFunction_hxx <IntPatch_ArcFunction.hxx>
0108 #define IntStart_ThePathPoint IntPatch_ThePathPointOfTheSOnBounds
0109 #define IntStart_ThePathPoint_hxx <IntPatch_ThePathPointOfTheSOnBounds.hxx>
0110 #define IntStart_SequenceOfPathPoint NCollection_Sequence<IntPatch_ThePathPointOfTheSOnBounds>
0111 #define IntStart_SequenceOfPathPoint_hxx                                                           \
0112   <NCollection_Sequence<IntPatch_ThePathPointOfTheSOnBounds>.hxx>
0113 #define IntStart_TheSegment IntPatch_TheSegmentOfTheSOnBounds
0114 #define IntStart_TheSegment_hxx <IntPatch_TheSegmentOfTheSOnBounds.hxx>
0115 #define IntStart_SequenceOfSegment NCollection_Sequence<IntPatch_TheSegmentOfTheSOnBounds>
0116 #define IntStart_SequenceOfSegment_hxx                                                             \
0117   <NCollection_Sequence<IntPatch_TheSegmentOfTheSOnBounds>.hxx>
0118 #define IntStart_SearchOnBoundaries IntPatch_TheSOnBounds
0119 #define IntStart_SearchOnBoundaries_hxx <IntPatch_TheSOnBounds.hxx>
0120
0121 #include <IntStart_SearchOnBoundaries.lxx>
0122
0123 #undef TheVertex
0124 #undef TheVertex_hxx
0125 #undef TheArc
0126 #undef TheArc_hxx
0127 #undef TheArcTool
0128 #undef TheArcTool_hxx
0129 #undef TheSOBTool
0130 #undef TheSOBTool_hxx
0131 #undef Handle_TheTopolTool
0132 #undef TheTopolTool
0133 #undef TheTopolTool_hxx
0134 #undef TheFunction
0135 #undef TheFunction_hxx
0136 #undef IntStart_ThePathPoint
0137 #undef IntStart_ThePathPoint_hxx
0138 #undef IntStart_SequenceOfPathPoint
0139 #undef IntStart_SequenceOfPathPoint_hxx
0140 #undef IntStart_TheSegment
0141 #undef IntStart_TheSegment_hxx
0142 #undef IntStart_SequenceOfSegment
0143 #undef IntStart_SequenceOfSegment_hxx
0144 #undef IntStart_SearchOnBoundaries
0145 #undef IntStart_SearchOnBoundaries_hxx
0146
0147 #endif // _IntPatch_TheSOnBounds_HeaderFile