include/opencascade/TNaming_Builder.hxx

0001 // Created on: 1996-12-16
0002 // Created by: Remi Lequette
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 _TNaming_Builder_HeaderFile
0018 #define _TNaming_Builder_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class TNaming_UsedShapes;
0025 class TNaming_NamedShape;
0026 class Standard_ConstructionError;
0027 class TDF_Label;
0028 class TopoDS_Shape;
0029
0030
0031 //! A tool to create and maintain topological attributes.
0032 //! Constructor creates an empty
0033 //! TNaming_NamedShape attribute at the given
0034 //! label. It allows adding "old shape" and "new
0035 //! shape" pairs with the specified evolution to this
0036 //! named shape. One evolution type per one
0037 //! builder must be used.
0038 class TNaming_Builder
0039 {
0040 public:
0041
0042   DEFINE_STANDARD_ALLOC
0043
0044
0045   //! Create an   Builder.
0046   //! Warning:  Before Addition copies the current Value, and clear
0047   Standard_EXPORT TNaming_Builder(const TDF_Label& aLabel);
0048
0049   //! Records the shape newShape which was
0050   //! generated during a topological construction.
0051   //! As an example, consider the case of a face
0052   //! generated in construction of a box.
0053   Standard_EXPORT void Generated (const TopoDS_Shape& newShape);
0054
0055   //! Records the shape newShape which was
0056   //! generated from the shape oldShape during a topological construction.
0057   //! As an example, consider the case of a face
0058   //! generated from an edge in construction of a prism.
0059   Standard_EXPORT void Generated (const TopoDS_Shape& oldShape, const TopoDS_Shape& newShape);
0060
0061   //! Records the shape oldShape which was deleted from the current label.
0062   //! As an example, consider the case of a face removed by a Boolean operation.
0063   Standard_EXPORT void Delete (const TopoDS_Shape& oldShape);
0064
0065   //! Records the shape newShape which is a
0066   //! modification of the shape oldShape.
0067   //! As an example, consider the case of a face split
0068   //! or merged in a Boolean operation.
0069   Standard_EXPORT void Modify (const TopoDS_Shape& oldShape, const TopoDS_Shape& newShape);
0070
0071   //! Add a  Shape to the current label ,  This Shape is
0072   //! unmodified.  Used for example  to define a set
0073   //! of shapes under a label.
0074   Standard_EXPORT void Select (const TopoDS_Shape& aShape, const TopoDS_Shape& inShape);
0075
0076   //! Returns the NamedShape which has been built or is under construction.
0077   Standard_EXPORT Handle(TNaming_NamedShape) NamedShape() const;
0078
0079
0080
0081
0082 protected:
0083
0084
0085
0086
0087
0088 private:
0089
0090
0091
0092   Handle(TNaming_UsedShapes) myShapes;
0093   Handle(TNaming_NamedShape) myAtt;
0094
0095
0096 };
0097
0098
0099
0100
0101
0102
0103
0104 #endif // _TNaming_Builder_HeaderFile