include/opencascade/XSAlgo_AlgoContainer.hxx

0001 // Created on: 2000-01-19
0002 // Created by: data exchange team
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _XSAlgo_AlgoContainer_HeaderFile
0017 #define _XSAlgo_AlgoContainer_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Message_ProgressRange.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_Transient.hxx>
0025 #include <TopAbs_ShapeEnum.hxx>
0026
0027 class XSAlgo_ToolContainer;
0028 class TopoDS_Shape;
0029 class TopoDS_Edge;
0030 class TopoDS_Face;
0031 class Transfer_TransientProcess;
0032 class Transfer_FinderProcess;
0033
0034 class XSAlgo_AlgoContainer;
0035 DEFINE_STANDARD_HANDLE(XSAlgo_AlgoContainer, Standard_Transient)
0036
0037 class XSAlgo_AlgoContainer : public Standard_Transient
0038 {
0039 public:
0040   //! Empty constructor
0041   XSAlgo_AlgoContainer() {};
0042
0043   //! Performs actions necessary for preparing environment
0044   //! for transfer. Empty in Open version.
0045   Standard_EXPORT virtual void PrepareForTransfer() const;
0046
0047   //! Does shape processing with specified tolerances
0048   //! @param[in] theShape shape to process
0049   //! @param[in] thePrec basic precision and tolerance
0050   //! @param[in] theMaxTol maximum allowed tolerance
0051   //! @param[in] thePrscfile name of the resource file
0052   //! @param[in] thePseq name of the sequence of operators defined in the resource file for Shape
0053   //! Processing
0054   //! @param[out] theInfo information to be recorded in the translation map
0055   //! @param[in] theProgress progress indicator
0056   //! @param[in] theNonManifold flag to proceed with non-manifold topology
0057   //! @param[in] theDetailingLevel the lowest shape type to be processed, lower shapes are ignored
0058   //! @return the processed shape
0059   Standard_EXPORT virtual TopoDS_Shape ProcessShape(
0060     const TopoDS_Shape&          theShape,
0061     const Standard_Real          thePrec,
0062     const Standard_Real          theMaxTol,
0063     const Standard_CString       thePrscfile,
0064     const Standard_CString       thePseq,
0065     Handle(Standard_Transient)&  theInfo,
0066     const Message_ProgressRange& theProgress       = Message_ProgressRange(),
0067     const Standard_Boolean       theNonManifold    = Standard_False,
0068     const TopAbs_ShapeEnum       theDetailingLevel = TopAbs_VERTEX) const;
0069
0070   //! Checks quality of pcurve of the edge on the given face,
0071   //! and corrects it if necessary.
0072   Standard_EXPORT virtual Standard_Boolean CheckPCurve(const TopoDS_Edge&     theEdge,
0073                                                        const TopoDS_Face&     theFace,
0074                                                        const Standard_Real    thePrecision,
0075                                                        const Standard_Boolean theIsSeam) const;
0076
0077   Standard_EXPORT virtual void MergeTransferInfo(const Handle(Transfer_TransientProcess)& TP,
0078                                                  const Handle(Standard_Transient)&        info,
0079                                                  const Standard_Integer startTPitem = 1) const;
0080
0081   //! Updates translation map (TP or FP) with information
0082   //! resulting from ShapeProcessing
0083   //! Parameter startTPitem can be used for optimisation, to
0084   //! restrict modifications to entities stored in TP starting
0085   //! from item startTPitem
0086   Standard_EXPORT virtual void MergeTransferInfo(const Handle(Transfer_FinderProcess)& FP,
0087                                                  const Handle(Standard_Transient)&     info) const;
0088
0089   DEFINE_STANDARD_RTTIEXT(XSAlgo_AlgoContainer, Standard_Transient)
0090 };
0091
0092 #endif // _XSAlgo_AlgoContainer_HeaderFile