include/opencascade/Intf_Interference.hxx

0001 // Created on: 1991-06-24
0002 // Created by: Didier PIFFAULT
0003 // Copyright (c) 1991-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 _Intf_Interference_HeaderFile
0018 #define _Intf_Interference_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Intf_SectionPoint.hxx>
0025 #include <NCollection_Sequence.hxx>
0026 #include <Intf_SectionLine.hxx>
0027 #include <Intf_TangentZone.hxx>
0028 #include <Standard_Boolean.hxx>
0029 class Intf_SectionPoint;
0030 class Intf_SectionLine;
0031 class Intf_TangentZone;
0032
0033 //! Describes the Interference computation result
0034 //! between polygon2d or polygon3d or polyhedron
0035 //! (as three sequences of points of intersection,
0036 //! polylines of intersection and zones de tangence).
0037 class Intf_Interference
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Gives the number of points of intersection in the
0043   //! interference.
0044   int NbSectionPoints() const;
0045
0046   //! Gives the point of intersection of address Index in
0047   //! the interference.
0048   const Intf_SectionPoint& PntValue(const int Index) const;
0049
0050   //! Gives the number of polylines of intersection in the
0051   //! interference.
0052   int NbSectionLines() const;
0053
0054   //! Gives the polyline of intersection at address <Index> in
0055   //! the interference.
0056   const Intf_SectionLine& LineValue(const int Index) const;
0057
0058   //! Gives the number of zones of tangence in the interference.
0059   int NbTangentZones() const;
0060
0061   //! Gives the zone of tangence at address Index in the
0062   //! interference.
0063   const Intf_TangentZone& ZoneValue(const int Index) const;
0064
0065   //! Gives the tolerance used for the calculation.
0066   double GetTolerance() const;
0067
0068   //! Tests if the polylines of intersection or the zones of
0069   //! tangence contain the point of intersection <ThePnt>.
0070   Standard_EXPORT bool Contains(const Intf_SectionPoint& ThePnt) const;
0071
0072   //! Inserts a new zone of tangence in the current list of
0073   //! tangent zones of the interference and returns True
0074   //! when done.
0075   Standard_EXPORT bool Insert(const Intf_TangentZone& TheZone);
0076
0077   //! Insert a new segment of intersection in the current list of
0078   //! polylines of intersection of the interference.
0079   Standard_EXPORT void Insert(const Intf_SectionPoint& pdeb, const Intf_SectionPoint& pfin);
0080
0081   Standard_EXPORT void Dump() const;
0082
0083 protected:
0084   //! Empty constructor
0085   Standard_EXPORT Intf_Interference(const bool Self);
0086
0087   //! Destructor is protected, for safer inheritance
0088   ~Intf_Interference() = default;
0089
0090   //! Only one argument for the intersection.
0091   Standard_EXPORT void SelfInterference(const bool Self);
0092
0093   NCollection_Sequence<Intf_SectionPoint> mySPoins;
0094   NCollection_Sequence<Intf_SectionLine>  mySLines;
0095   NCollection_Sequence<Intf_TangentZone>  myTZones;
0096   bool                                    SelfIntf;
0097   double                                  Tolerance;
0098 };
0099
0100 #include <Intf_Interference.lxx>
0101
0102 #endif // _Intf_Interference_HeaderFile