include/opencascade/Interface_ShareFlags.hxx

0001 // Created on: 1993-04-05
0002 // Created by: Christian CAILLET
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 _Interface_ShareFlags_HeaderFile
0018 #define _Interface_ShareFlags_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Interface_BitMap.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <NCollection_Sequence.hxx>
0027 #include <NCollection_HSequence.hxx>
0028 #include <Standard_Integer.hxx>
0029 class Interface_InterfaceModel;
0030 class Interface_GeneralLib;
0031 class Interface_GTool;
0032 class Interface_Protocol;
0033 class Interface_Graph;
0034 class Standard_Transient;
0035 class Interface_EntityIterator;
0036
0037 //! This class only says for each Entity of a Model, if it is
0038 //! Shared or not by one or more other(s) of this Model
0039 //! It uses the General Service "Shared".
0040 class Interface_ShareFlags
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Creates a ShareFlags from a Model and builds required data
0046   //! (flags) by calling the General Service Library given as
0047   //! argument <lib>
0048   Standard_EXPORT Interface_ShareFlags(const occ::handle<Interface_InterfaceModel>& amodel,
0049                                        const Interface_GeneralLib&                  lib);
0050
0051   //! Same as above, but GeneralLib is detained by a GTool
0052   Standard_EXPORT Interface_ShareFlags(const occ::handle<Interface_InterfaceModel>& amodel,
0053                                        const occ::handle<Interface_GTool>&          gtool);
0054
0055   //! Same as above, but GeneralLib is defined through a Protocol
0056   Standard_EXPORT Interface_ShareFlags(const occ::handle<Interface_InterfaceModel>& amodel,
0057                                        const occ::handle<Interface_Protocol>&       protocol);
0058
0059   //! Same as above, but works with the GTool of the Model
0060   Standard_EXPORT Interface_ShareFlags(const occ::handle<Interface_InterfaceModel>& amodel);
0061
0062   //! Creates a ShareFlags by querying information from a Graph
0063   //! (remark that Graph also has a method IsShared)
0064   Standard_EXPORT Interface_ShareFlags(const Interface_Graph& agraph);
0065
0066   //! Returns the Model used for the evaluation
0067   Standard_EXPORT occ::handle<Interface_InterfaceModel> Model() const;
0068
0069   //! Returns True if <ent> is Shared by one or more other
0070   //! Entity(ies) of the Model
0071   Standard_EXPORT bool IsShared(const occ::handle<Standard_Transient>& ent) const;
0072
0073   //! Returns the Entities which are not Shared (see their flags)
0074   Standard_EXPORT Interface_EntityIterator RootEntities() const;
0075
0076   //! Returns the count of root entities
0077   Standard_EXPORT int NbRoots() const;
0078
0079   //! Returns a root entity according its rank in the list of roots
0080   //! By default, it returns the first one
0081   Standard_EXPORT occ::handle<Standard_Transient> Root(const int num = 1) const;
0082
0083 private:
0084   //! Computes flags at Creation time
0085   //!
0086   //! Normally, gtool suffices. But if a Graph is created from a
0087   //! GeneralLib directly, it cannot be used
0088   //! If <gtool> is defined, it has priority
0089   Standard_EXPORT void Evaluate(const Interface_GeneralLib&         lib,
0090                                 const occ::handle<Interface_GTool>& gtool);
0091
0092   occ::handle<Interface_InterfaceModel>                               themodel;
0093   Interface_BitMap                                                    theflags;
0094   occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>> theroots;
0095 };
0096
0097 #endif // _Interface_ShareFlags_HeaderFile