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