// Created on: 2000-09-26 // Created by: Pavel TELKOV. // Copyright (c) 2000-2014 OPEN CASCADE SAS // // This file is part of Open CASCADE Technology software library. // // This library is free software; you can redistribute it and/or modify it under // the terms of the GNU Lesser General Public License version 2.1 as published // by the Free Software Foundation, with special exception defined in the file // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT // distribution for complete text of the license and disclaimer of any warranty. // // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. #ifndef _XCAFDoc_LayerTool_HeaderFile #define _XCAFDoc_LayerTool_HeaderFile #include #include #include #include #include #include class XCAFDoc_ShapeTool; class TDF_Label; class Standard_GUID; class TCollection_ExtendedString; class TopoDS_Shape; class TDF_Attribute; class TDF_RelocationTable; class XCAFDoc_LayerTool; DEFINE_STANDARD_HANDLE(XCAFDoc_LayerTool, TDataStd_GenericEmpty) //! Provides tools to store and retrieve attributes (Layers) //! of TopoDS_Shape in and from TDocStd_Document //! A Document is intended to hold different //! attributes of ONE shape and it's sub-shapes //! Provide tools for management of Layers section of document. class XCAFDoc_LayerTool : public TDataStd_GenericEmpty { public: Standard_EXPORT XCAFDoc_LayerTool(); //! Creates (if not exist) LayerTool. Standard_EXPORT static Handle(XCAFDoc_LayerTool) Set (const TDF_Label& L); Standard_EXPORT static const Standard_GUID& GetID(); //! returns the label under which Layers are stored Standard_EXPORT TDF_Label BaseLabel() const; //! Returns internal XCAFDoc_ShapeTool tool Standard_EXPORT const Handle(XCAFDoc_ShapeTool)& ShapeTool(); //! Returns True if label belongs to a Layertable and //! is a Layer definition Standard_EXPORT Standard_Boolean IsLayer (const TDF_Label& lab) const; //! Returns Layer defined by label lab //! Returns False if the label is not in Layertable //! or does not define a Layer Standard_EXPORT Standard_Boolean GetLayer (const TDF_Label& lab, TCollection_ExtendedString& aLayer) const; //! Finds a Layer definition in a Layertable and returns //! its label if found //! Returns False if Layer is not found in Layertable Standard_EXPORT Standard_Boolean FindLayer (const TCollection_ExtendedString& aLayer, TDF_Label& lab) const; //! Finds a Layer definition in a Layertable and returns //! its label if found (or Null label else) Standard_EXPORT TDF_Label FindLayer (const TCollection_ExtendedString& aLayer) const; //! Adds a Layer definition to a Layertable and returns //! its label (returns existing label if the same Layer //! is already defined) Standard_EXPORT TDF_Label AddLayer (const TCollection_ExtendedString& aLayer) const; //! Removes Layer from the Layertable Standard_EXPORT void RemoveLayer (const TDF_Label& lab) const; //! Returns a sequence of Layers currently stored //! in the Layertable Standard_EXPORT void GetLayerLabels (TDF_LabelSequence& Labels) const; //! Sets a link from label to Layer //! defined by //! optional parametr show could shape be //! in number of layers or only in one. Standard_EXPORT void SetLayer (const TDF_Label& L, const TDF_Label& LayerL, const Standard_Boolean shapeInOneLayer = Standard_False) const; //! Sets a link from label to Layer //! in the Layertable //! Adds a Layer as necessary //! optional parametr show could shape be //! in number of layers or only in one. Standard_EXPORT void SetLayer (const TDF_Label& L, const TCollection_ExtendedString& aLayer, const Standard_Boolean shapeInOneLayer = Standard_False) const; //! Removes a link from label to all layers Standard_EXPORT void UnSetLayers (const TDF_Label& L) const; //! Remove link from label and Layer . //! returns FALSE if no such layer. Standard_EXPORT Standard_Boolean UnSetOneLayer (const TDF_Label& L, const TCollection_ExtendedString& aLayer) const; //! Remove link from label and Layer . //! returns FALSE if is not a layer label. Standard_EXPORT Standard_Boolean UnSetOneLayer (const TDF_Label& L, const TDF_Label& aLayerL) const; //! Returns True if label has a Layer assosiated //! with the . Standard_EXPORT Standard_Boolean IsSet (const TDF_Label& L, const TCollection_ExtendedString& aLayer) const; //! Returns True if label has a Layer assosiated //! with the label. Standard_EXPORT Standard_Boolean IsSet (const TDF_Label& L, const TDF_Label& aLayerL) const; //! Return sequence of strings that assosiated with label . Standard_EXPORT Standard_Boolean GetLayers (const TDF_Label& L, Handle(TColStd_HSequenceOfExtendedString)& aLayerS); //! Return sequence of labels that assosiated with label . Standard_EXPORT Standard_Boolean GetLayers (const TDF_Label& L, TDF_LabelSequence& aLayerLS); //! Return sequence of strings that assosiated with label . Standard_EXPORT Handle(TColStd_HSequenceOfExtendedString) GetLayers (const TDF_Label& L); //! Return sequanese of shape labels that assigned with layers to . Standard_EXPORT void GetShapesOfLayer (const TDF_Label& layerL, TDF_LabelSequence& ShLabels) const; //! Return TRUE if layer is visible, FALSE if invisible. Standard_EXPORT Standard_Boolean IsVisible (const TDF_Label& layerL) const; //! Set the visibility of layer. If layer is invisible when on it's layer //! will set UAttribute with corresponding GUID. Standard_EXPORT void SetVisibility (const TDF_Label& layerL, const Standard_Boolean isvisible = Standard_True) const; //! Sets a link from label that containig shape //! with layer that situated at label . //! optional parametr show could shape be //! in number of layers or only in one. //! return FALSE if no such shape or label Standard_EXPORT Standard_Boolean SetLayer (const TopoDS_Shape& Sh, const TDF_Label& LayerL, const Standard_Boolean shapeInOneLayer = Standard_False); //! Sets a link from label that containig shape //! with layer . Add to LayerTable if nessesery. //! optional parametr show could shape be //! in number of layers or only in one. //! return FALSE if no such shape . Standard_EXPORT Standard_Boolean SetLayer (const TopoDS_Shape& Sh, const TCollection_ExtendedString& aLayer, const Standard_Boolean shapeInOneLayer = Standard_False); //! Remove link between shape and all Layers at LayerTable. //! return FALSE if no such shape in XCAF Document. Standard_EXPORT Standard_Boolean UnSetLayers (const TopoDS_Shape& Sh); //! Remove link between shape and layer . //! returns FALSE if no such layer or shape . Standard_EXPORT Standard_Boolean UnSetOneLayer (const TopoDS_Shape& Sh, const TCollection_ExtendedString& aLayer); //! Remove link between shape and layer . //! returns FALSE if no such layer or shape . Standard_EXPORT Standard_Boolean UnSetOneLayer (const TopoDS_Shape& Sh, const TDF_Label& aLayerL); //! Returns True if shape has a Layer assosiated //! with the . Standard_EXPORT Standard_Boolean IsSet (const TopoDS_Shape& Sh, const TCollection_ExtendedString& aLayer); //! Returns True if shape has a Layer assosiated //! with the . Standard_EXPORT Standard_Boolean IsSet (const TopoDS_Shape& Sh, const TDF_Label& aLayerL); //! Return sequence of strings that assosiated with shape . Standard_EXPORT Standard_Boolean GetLayers (const TopoDS_Shape& Sh, Handle(TColStd_HSequenceOfExtendedString)& aLayerS); //! Return sequence of labels that assosiated with shape . Standard_EXPORT Standard_Boolean GetLayers (const TopoDS_Shape& Sh, TDF_LabelSequence& aLayerLS); //! Return sequence of strings that assosiated with shape . Standard_EXPORT Handle(TColStd_HSequenceOfExtendedString) GetLayers (const TopoDS_Shape& Sh); Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE; //! Dumps the content of me into the stream Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE; DEFINE_DERIVED_ATTRIBUTE(XCAFDoc_LayerTool,TDataStd_GenericEmpty) private: Handle(XCAFDoc_ShapeTool) myShapeTool; }; #endif // _XCAFDoc_LayerTool_HeaderFile