src/XSAlgo/XSAlgo_AlgoContainer.hxx

   1 // Created on: 2000-01-19
   2 // Created by: data exchange team
   3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _XSAlgo_AlgoContainer_HeaderFile
  17 #define _XSAlgo_AlgoContainer_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <Standard_Transient.hxx>
  23 #include <Standard_Real.hxx>
  24 #include <Standard_CString.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Standard_Integer.hxx>
  27 class XSAlgo_ToolContainer;
  28 class TopoDS_Shape;
  29 class Standard_Transient;
  30 class Message_ProgressIndicator;
  31 class TopoDS_Edge;
  32 class TopoDS_Face;
  33 class Transfer_TransientProcess;
  34 class Transfer_FinderProcess;
  35
  36
  37 class XSAlgo_AlgoContainer;
  38 DEFINE_STANDARD_HANDLE(XSAlgo_AlgoContainer, Standard_Transient)
  39
  40
  41 class XSAlgo_AlgoContainer : public Standard_Transient
  42 {
  43
  44 public:
  45
  46
  47   //! Empty constructor
  48   Standard_EXPORT XSAlgo_AlgoContainer();
  49
  50   //! Sets ToolContainer
  51     void SetToolContainer (const Handle(XSAlgo_ToolContainer)& TC);
  52
  53   //! Returns ToolContainer
  54     Handle(XSAlgo_ToolContainer) ToolContainer() const;
  55
  56   //! Performs actions necessary for preparing environment
  57   //! for transfer. Empty in Open version.
  58   Standard_EXPORT virtual void PrepareForTransfer() const;
  59
  60   //! Does shape processing with specified tolerances
  61   //! and returns resulting shape and associated information
  62   //! in the form of Transient.
  63   //! This information should be later transmitted to
  64   //! MergeTransferInfo in order to be recorded in the
  65   //! translation map
  66   Standard_EXPORT virtual TopoDS_Shape ProcessShape (
  67       const TopoDS_Shape& shape, const Standard_Real Prec, const Standard_Real MaxTol,
  68       const Standard_CString rscfile, const Standard_CString seq, Handle(Standard_Transient)& info,
  69       const Handle(Message_ProgressIndicator)& progress = 0,
  70       const Standard_Boolean NonManifold = Standard_False) const;
  71
  72   //! Checks quality of pcurve of the edge on the given face,
  73   //! and corrects it if necessary.
  74   Standard_EXPORT virtual Standard_Boolean CheckPCurve (const TopoDS_Edge& edge, const TopoDS_Face& face, const Standard_Real preci, const Standard_Boolean isSeam) const;
  75
  76   Standard_EXPORT virtual void MergeTransferInfo (const Handle(Transfer_TransientProcess)& TP, const Handle(Standard_Transient)& info, const Standard_Integer startTPitem = 1) const;
  77
  78   //! Updates translation map (TP or FP) with information
  79   //! resulting from ShapeProcessing
  80   //! Parameter startTPitem can be used for optimisation, to
  81   //! restrict modifications to entities stored in TP starting
  82   //! from item startTPitem
  83   Standard_EXPORT virtual void MergeTransferInfo (const Handle(Transfer_FinderProcess)& FP, const Handle(Standard_Transient)& info) const;
  84
  85
  86
  87
  88   DEFINE_STANDARD_RTTIEXT(XSAlgo_AlgoContainer,Standard_Transient)
  89
  90 protected:
  91
  92
  93
  94
  95 private:
  96
  97
  98   Handle(XSAlgo_ToolContainer) myTC;
  99
 100
 101 };
 102
 103
 104 #include <XSAlgo_AlgoContainer.lxx>
 105
 106
 107
 108
 109
 110 #endif // _XSAlgo_AlgoContainer_HeaderFile