include/opencascade/BRepFilletAPI_LocalOperation.hxx

0001 // Created on: 1998-01-29
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1998-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 _BRepFilletAPI_LocalOperation_HeaderFile
0018 #define _BRepFilletAPI_LocalOperation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <BRepBuilderAPI_MakeShape.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <ChFiDS_CircSection.hxx>
0027 #include <NCollection_Array1.hxx>
0028 #include <NCollection_HArray1.hxx>
0029 class TopoDS_Edge;
0030 class TopoDS_Vertex;
0031
0032 //! Construction of fillets on the edges of a Shell.
0033 class BRepFilletAPI_LocalOperation : public BRepBuilderAPI_MakeShape
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Adds a contour in the builder (builds a
0039   //! contour of tangent edges).
0040   Standard_EXPORT virtual void Add(const TopoDS_Edge& E) = 0;
0041
0042   //! Reset the contour of index IC, there is nomore
0043   //! information in the contour.
0044   Standard_EXPORT virtual void ResetContour(const int IC) = 0;
0045
0046   //! Number of contours.
0047   Standard_EXPORT virtual int NbContours() const = 0;
0048
0049   //! Returns the index of the contour containing the edge
0050   //! E, returns 0 if E doesn't belong to any contour.
0051   Standard_EXPORT virtual int Contour(const TopoDS_Edge& E) const = 0;
0052
0053   //! Number of Edges in the contour I.
0054   Standard_EXPORT virtual int NbEdges(const int I) const = 0;
0055
0056   //! Returns the Edge J in the contour I.
0057   Standard_EXPORT virtual const TopoDS_Edge& Edge(const int I, const int J) const = 0;
0058
0059   //! remove the contour containing the Edge E.
0060   Standard_EXPORT virtual void Remove(const TopoDS_Edge& E) = 0;
0061
0062   //! returns the length the contour of index IC.
0063   Standard_EXPORT virtual double Length(const int IC) const = 0;
0064
0065   //! Returns the first Vertex of the contour of index IC.
0066   Standard_EXPORT virtual TopoDS_Vertex FirstVertex(const int IC) const = 0;
0067
0068   //! Returns the last Vertex of the contour of index IC.
0069   Standard_EXPORT virtual TopoDS_Vertex LastVertex(const int IC) const = 0;
0070
0071   //! returns the abscissa of the vertex V on
0072   //! the contour of index IC.
0073   Standard_EXPORT virtual double Abscissa(const int IC, const TopoDS_Vertex& V) const = 0;
0074
0075   //! returns the relative abscissa([0.,1.]) of the
0076   //! vertex V on the contour of index IC.
0077   Standard_EXPORT virtual double RelativeAbscissa(const int IC, const TopoDS_Vertex& V) const = 0;
0078
0079   //! returns true if the contour of index IC is closed
0080   //! an tangent.
0081   Standard_EXPORT virtual bool ClosedAndTangent(const int IC) const = 0;
0082
0083   //! returns true if the contour of index IC is closed
0084   Standard_EXPORT virtual bool Closed(const int IC) const = 0;
0085
0086   //! Reset all the fields updated by Build operation and
0087   //! leave the algorithm in the same state than before
0088   //! build call. It allows contours and radius
0089   //! modifications to build the result another time.
0090   Standard_EXPORT virtual void Reset() = 0;
0091
0092   Standard_EXPORT virtual void Simulate(const int IC) = 0;
0093
0094   Standard_EXPORT virtual int NbSurf(const int IC) const = 0;
0095
0096   Standard_EXPORT virtual occ::handle<NCollection_HArray1<ChFiDS_CircSection>> Sect(
0097     const int IC,
0098     const int IS) const = 0;
0099 };
0100
0101 #endif // _BRepFilletAPI_LocalOperation_HeaderFile