src/BRepToIGES/BRepToIGES_BREntity.hxx

   1 // Created on: 1994-11-15
   2 // Created by: Marie Jose MARTZ
   3 // Copyright (c) 1994-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _BRepToIGES_BREntity_HeaderFile
  18 #define _BRepToIGES_BREntity_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Real.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Standard_CString.hxx>
  27 #include <Message_ProgressRange.hxx>
  28
  29 class IGESData_IGESModel;
  30 class Transfer_FinderProcess;
  31 class IGESData_IGESEntity;
  32 class TopoDS_Shape;
  33 class Standard_Transient;
  34
  35
  36 //! provides methods to transfer BRep entity from CASCADE to IGES.
  37 class BRepToIGES_BREntity
  38 {
  39 public:
  40
  41   DEFINE_STANDARD_ALLOC
  42
  43
  44   //! Creates a tool BREntity
  45   Standard_EXPORT BRepToIGES_BREntity();
  46
  47   //! Initializes the field of the tool BREntity with
  48   //! default creating values.
  49   Standard_EXPORT void Init();
  50
  51   //! Set the value of "TheModel"
  52   Standard_EXPORT void SetModel (const Handle(IGESData_IGESModel)& model);
  53
  54   //! Returns the value of "TheModel"
  55   Standard_EXPORT Handle(IGESData_IGESModel) GetModel() const;
  56
  57   //! Returns the value of the UnitFlag of the header of the model
  58   //! in meters.
  59   Standard_EXPORT Standard_Real GetUnit() const;
  60
  61   //! Set the value of "TheMap"
  62   Standard_EXPORT void SetTransferProcess (const Handle(Transfer_FinderProcess)& TP);
  63
  64   //! Returns the value of "TheMap"
  65   Standard_EXPORT Handle(Transfer_FinderProcess) GetTransferProcess() const;
  66
  67   //! Returns the result of the transfert of any Shape
  68   //! If  the transfer has  failed, this member return a NullEntity.
  69   Standard_EXPORT virtual Handle(IGESData_IGESEntity) TransferShape
  70                    (const TopoDS_Shape& start,
  71                     const Message_ProgressRange& theProgress = Message_ProgressRange());
  72
  73   //! Records a new Fail message
  74   Standard_EXPORT void AddFail (const TopoDS_Shape& start, const Standard_CString amess);
  75
  76   //! Records a new Warning message
  77   Standard_EXPORT void AddWarning (const TopoDS_Shape& start, const Standard_CString amess);
  78
  79   //! Records a new Fail message
  80   Standard_EXPORT void AddFail (const Handle(Standard_Transient)& start, const Standard_CString amess);
  81
  82   //! Records a new Warning message
  83   Standard_EXPORT void AddWarning (const Handle(Standard_Transient)& start, const Standard_CString amess);
  84
  85   //! Returns True if start was already treated and has a result in "TheMap"
  86   //! else returns False.
  87   Standard_EXPORT Standard_Boolean HasShapeResult (const TopoDS_Shape& start) const;
  88
  89   //! Returns the result of the transfer of the Shape "start" contained
  90   //! in "TheMap" . (if HasShapeResult is True).
  91   Standard_EXPORT Handle(Standard_Transient) GetShapeResult (const TopoDS_Shape& start) const;
  92
  93   //! set in "TheMap" the result of the transfer of the Shape "start".
  94   Standard_EXPORT void SetShapeResult (const TopoDS_Shape& start, const Handle(Standard_Transient)& result);
  95
  96   //! Returns True if start was already treated and has a result in "TheMap"
  97   //! else returns False.
  98   Standard_EXPORT Standard_Boolean HasShapeResult (const Handle(Standard_Transient)& start) const;
  99
 100   //! Returns the result of the transfer of the Transient "start" contained
 101   //! in "TheMap" . (if HasShapeResult is True).
 102   Standard_EXPORT Handle(Standard_Transient) GetShapeResult (const Handle(Standard_Transient)& start) const;
 103
 104   //! set in "TheMap" the result of the transfer of the Transient "start".
 105   Standard_EXPORT void SetShapeResult (const Handle(Standard_Transient)& start, const Handle(Standard_Transient)& result);
 106
 107   //! Returns mode for conversion of surfaces
 108   //! (value of parameter write.convertsurface.mode)
 109   Standard_EXPORT Standard_Boolean GetConvertSurfaceMode() const;
 110
 111   //! Returns mode for writing pcurves
 112   //! (value of parameter write.surfacecurve.mode)
 113   Standard_EXPORT Standard_Boolean GetPCurveMode() const;
 114
 115   Standard_EXPORT virtual ~BRepToIGES_BREntity();
 116
 117 private:
 118   Handle(IGESData_IGESModel) TheModel;
 119   Standard_Real TheUnitFactor;
 120   Standard_Boolean myConvSurface;
 121   Standard_Boolean myPCurveMode;
 122   Handle(Transfer_FinderProcess) TheMap;
 123 };
 124
 125 #endif // _BRepToIGES_BREntity_HeaderFile