include/opencascade/BRepFeat_MakePipe.hxx

0001 // Created on: 1996-09-03
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1996-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 _BRepFeat_MakePipe_HeaderFile
0018 #define _BRepFeat_MakePipe_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopoDS_Shape.hxx>
0025 #include <NCollection_List.hxx>
0026 #include <TopTools_ShapeMapHasher.hxx>
0027 #include <NCollection_DataMap.hxx>
0028 #include <TopoDS_Wire.hxx>
0029 #include <BRepFeat_Form.hxx>
0030 #include <Standard_Integer.hxx>
0031 class Geom_Curve;
0032 class TopoDS_Edge;
0033
0034 //! Constructs compound shapes with pipe
0035 //! features. These can be depressions or protrusions.
0036 //! The semantics of pipe feature creation is based on the construction of shapes:
0037 //! -   along a length
0038 //! -   up to a limiting face
0039 //! -   from a limiting face to a height.
0040 //! The shape defining construction of the pipe feature can be either the supporting edge or
0041 //! the concerned area of a face.
0042 //! In case of the supporting edge, this contour
0043 //! can be attached to a face of the basis shape
0044 //! by binding. When the contour is bound to this
0045 //! face, the information that the contour will
0046 //! slide on the face becomes available to the relevant class methods.
0047 //! In case of the concerned area of a face, you
0048 //! could, for example, cut it out and move it to a
0049 //! different height which will define the limiting
0050 //! face of a protrusion or depression.
0051 class BRepFeat_MakePipe : public BRepFeat_Form
0052 {
0053 public:
0054   DEFINE_STANDARD_ALLOC
0055
0056   //! initializes the pipe class.
0057   BRepFeat_MakePipe();
0058
0059   //! A face Pbase is selected in the
0060   //! shape Sbase to serve as the basis for the
0061   //! pipe. It will be defined by the wire Spine.
0062   //! Fuse offers a choice between:
0063   //! -   removing matter with a Boolean cut using the setting 0
0064   //! -   adding matter with Boolean fusion using the setting 1.
0065   //! The sketch face Skface serves to determine
0066   //! the type of operation. If it is inside the basis
0067   //! shape, a local operation such as glueing can be performed.
0068   BRepFeat_MakePipe(const TopoDS_Shape& Sbase,
0069                     const TopoDS_Shape& Pbase,
0070                     const TopoDS_Face&  Skface,
0071                     const TopoDS_Wire&  Spine,
0072                     const int           Fuse,
0073                     const bool          Modify);
0074
0075   //! Initializes this algorithm for adding pipes to shapes.
0076   //! A face Pbase is selected in the shape Sbase to
0077   //! serve as the basis for the pipe. It will be defined by the wire Spine.
0078   //! Fuse offers a choice between:
0079   //! -   removing matter with a Boolean cut using the setting 0
0080   //! -   adding matter with Boolean fusion using the setting 1.
0081   //! The sketch face Skface serves to determine
0082   //! the type of operation. If it is inside the basis
0083   //! shape, a local operation such as glueing can be performed.
0084   Standard_EXPORT void Init(const TopoDS_Shape& Sbase,
0085                             const TopoDS_Shape& Pbase,
0086                             const TopoDS_Face&  Skface,
0087                             const TopoDS_Wire&  Spine,
0088                             const int           Fuse,
0089                             const bool          Modify);
0090
0091   //! Indicates that the edge <E> will slide on the face
0092   //! <OnFace>. Raises ConstructionError if the face does not belong to the
0093   //! basis shape, or the edge to the prismed shape.
0094   Standard_EXPORT void Add(const TopoDS_Edge& E, const TopoDS_Face& OnFace);
0095
0096   Standard_EXPORT void Perform();
0097
0098   Standard_EXPORT void Perform(const TopoDS_Shape& Until);
0099
0100   //! Assigns one of the following semantics
0101   //! -   to a face Until
0102   //! -   from a face From to a height Until.
0103   //! Reconstructs the feature topologically according to the semantic option chosen.
0104   Standard_EXPORT void Perform(const TopoDS_Shape& From, const TopoDS_Shape& Until);
0105
0106   Standard_EXPORT void Curves(NCollection_Sequence<occ::handle<Geom_Curve>>& S) override;
0107
0108   Standard_EXPORT occ::handle<Geom_Curve> BarycCurve() override;
0109
0110 private:
0111   TopoDS_Shape myPbase;
0112   TopoDS_Face  mySkface;
0113   NCollection_DataMap<TopoDS_Shape, NCollection_List<TopoDS_Shape>, TopTools_ShapeMapHasher>
0114                                                 mySlface;
0115   TopoDS_Wire                                   mySpine;
0116   NCollection_Sequence<occ::handle<Geom_Curve>> myCurves;
0117   occ::handle<Geom_Curve>                       myBCurve;
0118 };
0119
0120 #include <BRepFeat_MakePipe.lxx>
0121
0122 #endif // _BRepFeat_MakePipe_HeaderFile