include/opencascade/BRepFeat_Gluer.hxx

0001 // Created on: 1996-03-08
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_Gluer_HeaderFile
0018 #define _BRepFeat_Gluer_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <LocOpe_Gluer.hxx>
0025 #include <BRepBuilderAPI_MakeShape.hxx>
0026 #include <LocOpe_Operation.hxx>
0027 #include <TopTools_ListOfShape.hxx>
0028 class TopoDS_Shape;
0029 class TopoDS_Face;
0030 class TopoDS_Edge;
0031
0032 //! One of the most significant aspects
0033 //! of BRepFeat functionality is the use of local operations as opposed
0034 //! to global ones. In a global operation, you would first
0035 //! construct a form of the type you wanted in your final feature, and
0036 //! then remove matter so that it could fit into your initial basis object.
0037 //! In a local operation, however, you specify the domain of the feature
0038 //! construction with aspects of the shape on which the feature is being
0039 //! created. These semantics are expressed in terms of a member
0040 //! shape of the basis shape from which - or up to which - matter will be
0041 //! added or removed. As a result, local operations make calculations
0042 //! simpler and faster than global operations.
0043 //! Glueing uses wires or edges of a face in the basis shape. These are
0044 //! to become a part of the feature. They are first cut out and then
0045 //! projected to a plane outside or inside the basis shape. By
0046 //! rebuilding the initial shape incorporating the edges and the
0047 //! faces of the tool, protrusion features can be constructed.
0048 class BRepFeat_Gluer : public BRepBuilderAPI_MakeShape
0049 {
0050 public:
0051   DEFINE_STANDARD_ALLOC
0052
0053   //! Initializes an empty constructor
0054   BRepFeat_Gluer();
0055
0056   //! Initializes the shapes to be glued, the new shape
0057   //! Snew and the basis shape Sbase.
0058   BRepFeat_Gluer(const TopoDS_Shape& Snew, const TopoDS_Shape& Sbase);
0059
0060   //! Initializes the new shape Snew and the basis shape
0061   //! Sbase for the local glueing operation.
0062   void Init(const TopoDS_Shape& Snew, const TopoDS_Shape& Sbase);
0063
0064   //! Defines a contact between Fnew on the new shape
0065   //! Snew and Fbase on the basis shape Sbase. Informs
0066   //! other methods that Fnew in the new shape Snew is
0067   //! connected to the face Fbase in the basis shape Sbase.
0068   //! The contact faces of the glued shape must not have
0069   //! parts outside the contact faces of the basis shape.
0070   //! This indicates that glueing is possible.
0071   void Bind(const TopoDS_Face& Fnew, const TopoDS_Face& Fbase);
0072
0073   //! nforms other methods that the edge Enew in the new
0074   //! shape is the same as the edge Ebase in the basis
0075   //! shape and is therefore attached to the basis shape. This
0076   //! indicates that glueing is possible.
0077   void Bind(const TopoDS_Edge& Enew, const TopoDS_Edge& Ebase);
0078
0079   //! Determine which operation type to use glueing or sliding.
0080   LocOpe_Operation OpeType() const;
0081
0082   //! Returns the basis shape of the compound shape.
0083   const TopoDS_Shape& BasisShape() const;
0084
0085   //! Returns the resulting compound shape.
0086   const TopoDS_Shape& GluedShape() const;
0087
0088   //! This is  called by  Shape().  It does  nothing but
0089   //! may be redefined.
0090   Standard_EXPORT virtual void Build(
0091     const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
0092
0093   //! returns the status of the Face after
0094   //! the shape creation.
0095   Standard_EXPORT virtual Standard_Boolean IsDeleted(const TopoDS_Shape& F) Standard_OVERRIDE;
0096
0097   //! returns the list of generated Faces.
0098   Standard_EXPORT virtual const TopTools_ListOfShape& Modified(const TopoDS_Shape& F)
0099     Standard_OVERRIDE;
0100
0101 protected:
0102 private:
0103   LocOpe_Gluer myGluer;
0104 };
0105
0106 #include <BRepFeat_Gluer.lxx>
0107
0108 #endif // _BRepFeat_Gluer_HeaderFile