include/opencascade/TopTools.hxx

0001 // Created on: 1993-01-14
0002 // Created by: Remi LEQUETTE
0003 // Copyright (c) 1993-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 _TopTools_HeaderFile
0018 #define _TopTools_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_OStream.hxx>
0025 class TopoDS_Shape;
0026
0027 //! The  TopTools package provides   utilities for the
0028 //! topological data structure.
0029 //!
0030 //! * ShapeMapHasher. Hash a  Shape base on the TShape
0031 //! and the Location. The Orientation is not used.
0032 //!
0033 //! * OrientedShapeMapHasher. Hash a Shape base on the
0034 //! TShape ,the Location and the Orientation.
0035 //!
0036 //! * Instantiations of TCollection for Shapes :
0037 //! MapOfShape
0038 //! IndexedMapOfShape
0039 //! DataMapOfIntegerShape
0040 //! DataMapOfShapeInteger
0041 //! DataMapOfShapeReal
0042 //! Array1OfShape
0043 //! HArray1OfShape
0044 //! SequenceOfShape
0045 //! HSequenceOfShape
0046 //! ListOfShape
0047 //! Array1OfListShape
0048 //! HArray1OfListShape
0049 //! DataMapOfIntegerListOfShape
0050 //! DataMapOfShapeListOfShape
0051 //! DataMapOfShapeListOfInteger
0052 //! IndexedDataMapOfShapeShape
0053 //! IndexedDataMapOfShapeListOfShape
0054 //! DataMapOfShapeShape
0055 //! IndexedMapOfOrientedShape
0056 //! DataMapOfShapeSequenceOfShape
0057 //! IndexedDataMapOfShapeAddress
0058 //! DataMapOfOrientedShapeShape
0059 //!
0060 //! * LocationSet : to write sets of locations.
0061 //!
0062 //! * ShapeSet : to writes sets of TShapes.
0063 //!
0064 //! Package Methods :
0065 //!
0066 //! Dump : To dump the topology of a Shape.
0067 class TopTools
0068 {
0069 public:
0070   DEFINE_STANDARD_ALLOC
0071
0072   //! A set of Shapes. Can be dump, wrote or read.
0073   //! Dumps the topological structure  of <Sh>  on the
0074   //! stream <S>.
0075   Standard_EXPORT static void Dump(const TopoDS_Shape& Sh, Standard_OStream& S);
0076
0077   //! This is to bypass an extraction bug. It will force
0078   //! the  inclusion    of  Standard_Integer.hxx  itself
0079   //! including Standard_OStream.hxx  at   the   correct
0080   //! position.
0081   Standard_EXPORT static void Dummy(const Standard_Integer I);
0082 };
0083
0084 #endif // _TopTools_HeaderFile