include/opencascade/BRepAlgo_Image.hxx

0001 // Created on: 1995-10-26
0002 // Created by: Yves FRICAUD
0003 // Copyright (c) 1995-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 _BRepAlgo_Image_HeaderFile
0018 #define _BRepAlgo_Image_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 <Standard_Boolean.hxx>
0029 #include <TopAbs_ShapeEnum.hxx>
0030 class TopoDS_Shape;
0031
0032 //! Stores link between a shape <S> and a shape <NewS>
0033 //! obtained from <S>. <NewS> is an image of <S>.
0034 class BRepAlgo_Image
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   Standard_EXPORT BRepAlgo_Image();
0040
0041   Standard_EXPORT void SetRoot(const TopoDS_Shape& S);
0042
0043   //! Links <NewS> as image of <OldS>.
0044   Standard_EXPORT void Bind(const TopoDS_Shape& OldS, const TopoDS_Shape& NewS);
0045
0046   //! Links <NewS> as image of <OldS>.
0047   Standard_EXPORT void Bind(const TopoDS_Shape& OldS, const NCollection_List<TopoDS_Shape>& NewS);
0048
0049   //! Add <NewS> to the image of <OldS>.
0050   Standard_EXPORT void Add(const TopoDS_Shape& OldS, const TopoDS_Shape& NewS);
0051
0052   //! Add <NewS> to the image of <OldS>.
0053   Standard_EXPORT void Add(const TopoDS_Shape& OldS, const NCollection_List<TopoDS_Shape>& NewS);
0054
0055   Standard_EXPORT void Clear();
0056
0057   //! Remove <S> to set of images.
0058   Standard_EXPORT void Remove(const TopoDS_Shape& S);
0059
0060   //! Removes the root <theRoot> from the list of roots and up and down maps.
0061   Standard_EXPORT void RemoveRoot(const TopoDS_Shape& Root);
0062
0063   //! Replaces the <OldRoot> with the <NewRoot>, so all images
0064   //! of the <OldRoot> become the images of the <NewRoot>.
0065   //! The <OldRoot> is removed.
0066   Standard_EXPORT void ReplaceRoot(const TopoDS_Shape& OldRoot, const TopoDS_Shape& NewRoot);
0067
0068   Standard_EXPORT const NCollection_List<TopoDS_Shape>& Roots() const;
0069
0070   Standard_EXPORT bool IsImage(const TopoDS_Shape& S) const;
0071
0072   //! Returns the generator of <S>
0073   Standard_EXPORT const TopoDS_Shape& ImageFrom(const TopoDS_Shape& S) const;
0074
0075   //! Returns the upper generator of <S>
0076   Standard_EXPORT const TopoDS_Shape& Root(const TopoDS_Shape& S) const;
0077
0078   Standard_EXPORT bool HasImage(const TopoDS_Shape& S) const;
0079
0080   //! Returns the Image of <S>.
0081   //! Returns <S> in the list if HasImage(S) is false.
0082   Standard_EXPORT const NCollection_List<TopoDS_Shape>& Image(const TopoDS_Shape& S) const;
0083
0084   //! Stores in <L> the images of images of...images of <S>.
0085   //! <L> contains only <S> if HasImage(S) is false.
0086   Standard_EXPORT void LastImage(const TopoDS_Shape& S, NCollection_List<TopoDS_Shape>& L) const;
0087
0088   //! Keeps only the link between roots and lastimage.
0089   Standard_EXPORT void Compact();
0090
0091   //! Deletes in the images the shape of type <ShapeType>
0092   //! which are not in <S>.
0093   //! Warning: Compact() must be call before.
0094   Standard_EXPORT void Filter(const TopoDS_Shape& S, const TopAbs_ShapeEnum ShapeType);
0095
0096 private:
0097   NCollection_List<TopoDS_Shape>                                                             roots;
0098   NCollection_DataMap<TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher>                   up;
0099   NCollection_DataMap<TopoDS_Shape, NCollection_List<TopoDS_Shape>, TopTools_ShapeMapHasher> down;
0100 };
0101
0102 #endif // _BRepAlgo_Image_HeaderFile