include/opencascade/Transfer_ActorOfTransientProcess.hxx

0001 // Created on: 1996-09-04
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1996-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 _Transfer_ActorOfTransientProcess_HeaderFile
0018 #define _Transfer_ActorOfTransientProcess_HeaderFile
0019
0020 #include <ShapeProcess.hxx>
0021 #include <Standard.hxx>
0022 #include <Transfer_ActorOfProcessForTransient.hxx>
0023 #include <XSAlgo_ShapeProcessor.hxx>
0024
0025 struct DE_ShapeFixParameters;
0026 class Transfer_Binder;
0027 class Standard_Transient;
0028 class Transfer_ProcessForTransient;
0029 class Transfer_TransientProcess;
0030
0031 class Transfer_ActorOfTransientProcess;
0032 DEFINE_STANDARD_HANDLE(Transfer_ActorOfTransientProcess, Transfer_ActorOfProcessForTransient)
0033
0034 //! The original class was renamed. Compatibility only
0035 class Transfer_ActorOfTransientProcess : public Transfer_ActorOfProcessForTransient
0036 {
0037 public:
0038   Standard_EXPORT Transfer_ActorOfTransientProcess();
0039
0040   Standard_EXPORT virtual Handle(Transfer_Binder) Transferring(
0041     const Handle(Standard_Transient)&           start,
0042     const Handle(Transfer_ProcessForTransient)& TP,
0043     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0044
0045   Standard_EXPORT virtual Handle(Transfer_Binder) Transfer(
0046     const Handle(Standard_Transient)&        start,
0047     const Handle(Transfer_TransientProcess)& TP,
0048     const Message_ProgressRange&             theProgress = Message_ProgressRange());
0049
0050   Standard_EXPORT virtual Handle(Standard_Transient) TransferTransient(
0051     const Handle(Standard_Transient)&        start,
0052     const Handle(Transfer_TransientProcess)& TP,
0053     const Message_ProgressRange&             theProgress = Message_ProgressRange());
0054
0055   //! Sets parameters for shape processing.
0056   //! @param theParameters the parameters for shape processing.
0057   Standard_EXPORT void SetShapeFixParameters(
0058     const XSAlgo_ShapeProcessor::ParameterMap& theParameters);
0059
0060   //! Sets parameters for shape processing.
0061   //! Parameters are moved from the input map.
0062   //! @param theParameters the parameters for shape processing.
0063   Standard_EXPORT void SetShapeFixParameters(XSAlgo_ShapeProcessor::ParameterMap&& theParameters);
0064
0065   //! Sets parameters for shape processing.
0066   //! Parameters from @p theParameters are copied to the internal map.
0067   //! Parameters from @p theAdditionalParameters are copied to the internal map
0068   //! if they are not present in @p theParameters.
0069   //! @param theParameters the parameters for shape processing.
0070   //! @param theAdditionalParameters the additional parameters for shape processing.
0071   Standard_EXPORT void SetShapeFixParameters(
0072     const DE_ShapeFixParameters&               theParameters,
0073     const XSAlgo_ShapeProcessor::ParameterMap& theAdditionalParameters = {});
0074
0075   //! Returns parameters for shape processing that was set by SetParameters() method.
0076   //! @return the parameters for shape processing. Empty map if no parameters were set.
0077   inline const XSAlgo_ShapeProcessor::ParameterMap& GetShapeFixParameters() const
0078   {
0079     return myShapeProcParams;
0080   }
0081
0082   //! Sets flags defining operations to be performed on shapes.
0083   //! @param theFlags The flags defining operations to be performed on shapes.
0084   Standard_EXPORT void SetProcessingFlags(const ShapeProcess::OperationsFlags& theFlags);
0085
0086   //! Returns flags defining operations to be performed on shapes.
0087   //! @return Pair: the flags defining operations to be performed on shapes and a boolean value that
0088   //! indicates
0089   //!         whether the flags were set.
0090   inline const XSAlgo_ShapeProcessor::ProcessingFlags& GetProcessingFlags() const
0091   {
0092     return myShapeProcFlags;
0093   }
0094
0095   DEFINE_STANDARD_RTTIEXT(Transfer_ActorOfTransientProcess, Transfer_ActorOfProcessForTransient)
0096
0097 private:
0098   // clang-format off
0099   XSAlgo_ShapeProcessor::ParameterMap myShapeProcParams; //!< Parameters for shape processing.
0100   XSAlgo_ShapeProcessor::ProcessingFlags myShapeProcFlags; //!< Flags defining operations to be performed on shapes.
0101   // clang-format on
0102 };
0103
0104 #endif // _Transfer_ActorOfTransientProcess_HeaderFile