include/opencascade/DNaming.hxx

0001 // Created on: 1997-01-08
0002 // Created by: VAUTHIER Jean-Claude
0003 // Copyright (c) 1997-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 _DNaming_HeaderFile
0018 #define _DNaming_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <TopTools_DataMapOfShapeShape.hxx>
0027 #include <TopTools_ListOfShape.hxx>
0028 #include <Draw_Interpretor.hxx>
0029 class TDataStd_Real;
0030 class TFunction_Function;
0031 class TDataStd_Integer;
0032 class TDataStd_Name;
0033 class TNaming_NamedShape;
0034 class gp_Ax1;
0035 class TDataStd_UAttribute;
0036 class TopoDS_Shape;
0037 class BRepBuilderAPI_MakeShape;
0038 class TNaming_Builder;
0039 class TDF_Label;
0040 class BRepAlgoAPI_BooleanOperation;
0041 class TDF_Data;
0042 class TCollection_AsciiString;
0043
0044
0045
0046 class DNaming
0047 {
0048 public:
0049
0050   DEFINE_STANDARD_ALLOC
0051
0052
0053   Standard_EXPORT static Handle(TDataStd_Real) GetReal (const Handle(TFunction_Function)& theFunction, const Standard_Integer thePosition);
0054
0055   Standard_EXPORT static Handle(TDataStd_Integer) GetInteger (const Handle(TFunction_Function)& theFunction, const Standard_Integer thePosition);
0056
0057   Standard_EXPORT static Handle(TDataStd_Name) GetString (const Handle(TFunction_Function)& theFunction, const Standard_Integer thePosition);
0058
0059   Standard_EXPORT static Standard_Boolean ComputeAxis (const Handle(TNaming_NamedShape)& theNS, gp_Ax1& theAx1);
0060
0061   Standard_EXPORT static Handle(TNaming_NamedShape) GetFunctionResult (const Handle(TFunction_Function)& theFunction);
0062
0063   Standard_EXPORT static Handle(TDataStd_UAttribute) GetObjectArg (const Handle(TFunction_Function)& theFunction, const Standard_Integer thePosition);
0064
0065   Standard_EXPORT static void SetObjectArg (const Handle(TFunction_Function)& theFunction, const Standard_Integer thePosition, const Handle(TDataStd_UAttribute)& theNewValue);
0066
0067   Standard_EXPORT static Handle(TNaming_NamedShape) GetObjectValue (const Handle(TDataStd_UAttribute)& theObject);
0068
0069   Standard_EXPORT static Handle(TFunction_Function) GetLastFunction (const Handle(TDataStd_UAttribute)& theObject);
0070
0071   Standard_EXPORT static Handle(TFunction_Function) GetFirstFunction (const Handle(TDataStd_UAttribute)& theObject);
0072
0073   Standard_EXPORT static Handle(TFunction_Function) GetPrevFunction (const Handle(TFunction_Function)& theFunction);
0074
0075   Standard_EXPORT static Handle(TDataStd_UAttribute) GetObjectFromFunction (const Handle(TFunction_Function)& theFunction);
0076
0077   Standard_EXPORT static Standard_Boolean IsAttachment (const Handle(TDataStd_UAttribute)& theObject);
0078
0079   Standard_EXPORT static Handle(TNaming_NamedShape) GetAttachmentsContext (const Handle(TDataStd_UAttribute)& theObject);
0080
0081   Standard_EXPORT static Standard_Boolean ComputeSweepDir (const TopoDS_Shape& theShape, gp_Ax1& theAxis);
0082
0083   Standard_EXPORT static void LoadAndOrientModifiedShapes (BRepBuilderAPI_MakeShape& MakeShape, const TopoDS_Shape& ShapeIn, const TopAbs_ShapeEnum GeneratedFrom, TNaming_Builder& Builder, const TopTools_DataMapOfShapeShape& SubShapesOfResult);
0084
0085   Standard_EXPORT static void LoadAndOrientGeneratedShapes (BRepBuilderAPI_MakeShape& MakeShape, const TopoDS_Shape& ShapeIn, const TopAbs_ShapeEnum GeneratedFrom, TNaming_Builder& Builder, const TopTools_DataMapOfShapeShape& SubShapesOfResult);
0086
0087   Standard_EXPORT static void LoadDeletedShapes (BRepBuilderAPI_MakeShape& MakeShape, const TopoDS_Shape& ShapeIn, const TopAbs_ShapeEnum KindOfDeletedShape, TNaming_Builder& Builder);
0088
0089   Standard_EXPORT static void LoadResult (const TDF_Label& theLabel, BRepAlgoAPI_BooleanOperation& MS);
0090
0091   Standard_EXPORT static TopoDS_Shape CurrentShape (const Standard_CString ShapeEntry, const Handle(TDF_Data)& Data);
0092
0093   Standard_EXPORT static void GetShape (const Standard_CString ShapeEntry, const Handle(TDF_Data)& Data, TopTools_ListOfShape& Shapes);
0094
0095   //! theStatus = 0  Not  found,
0096   //! theStatus = 1  One  shape,
0097   //! theStatus = 2  More than one shape.
0098   Standard_EXPORT static TCollection_AsciiString GetEntry (const TopoDS_Shape& Shape, const Handle(TDF_Data)& Data, Standard_Integer& theStatus);
0099
0100   //! Loads the Shape to DF
0101   Standard_EXPORT static void LoadImportedShape (const TDF_Label& theResultLabel, const TopoDS_Shape& theShape);
0102
0103   //! Reloads sub-shapes of the Shape to DF
0104   Standard_EXPORT static void LoadPrime (const TDF_Label& theResultLabel, const TopoDS_Shape& theShape);
0105
0106   Standard_EXPORT static void AllCommands (Draw_Interpretor& DI);
0107
0108   //! commands relatives to NamedShape
0109   Standard_EXPORT static void BasicCommands (Draw_Interpretor& DI);
0110
0111   Standard_EXPORT static void ToolsCommands (Draw_Interpretor& DI);
0112
0113   //! commands relatives to Naming
0114   Standard_EXPORT static void SelectionCommands (Draw_Interpretor& DI);
0115
0116   //! commands for  testing Naming
0117   Standard_EXPORT static void ModelingCommands (Draw_Interpretor& DI);
0118
0119 };
0120
0121 #endif // _DNaming_HeaderFile