include/opencascade/RWPly_Provider.hxx

0001 // Copyright (c) 2022 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _RWPly_Provider_HeaderFile
0015 #define _RWPly_Provider_HeaderFile
0016
0017 #include <DE_Provider.hxx>
0018
0019 //! The class to transfer PLY files.
0020 //! Writes any PLY files from OCCT.
0021 //! Each operation needs configuration node.
0022 //!
0023 //! Providers grouped by Vendor name and Format type.
0024 //! The Vendor name is "OCC"
0025 //! The Format type is "PLY"
0026 //! The import process isn't supported.
0027 //! The export process is supported.
0028 class RWPly_Provider : public DE_Provider
0029 {
0030 public:
0031   DEFINE_STANDARD_RTTIEXT(RWPly_Provider, DE_Provider)
0032
0033 public:
0034
0035   //! Default constructor
0036   //! Configure translation process with global configuration
0037   Standard_EXPORT RWPly_Provider();
0038
0039   //! Configure translation process
0040   //! @param[in] theNode object to copy
0041   Standard_EXPORT RWPly_Provider(const Handle(DE_ConfigurationNode)& theNode);
0042
0043 public:
0044
0045   //! Writes a CAD file, according internal configuration
0046   //! @param[in] thePath path to the export CAD file
0047   //! @param[out] theDocument document to export
0048   //! @param[in] theWS current work session
0049   //! @param theProgress[in] progress indicator
0050   //! @return true if Write operation has ended correctly
0051   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
0052                                      const Handle(TDocStd_Document)& theDocument,
0053                                      Handle(XSControl_WorkSession)& theWS,
0054                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0055
0056   //! Writes a CAD file, according internal configuration
0057   //! @param[in] thePath path to the export CAD file
0058   //! @param[out] theDocument document to export
0059   //! @param theProgress[in] progress indicator
0060   //! @return true if Write operation has ended correctly
0061   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
0062                                      const Handle(TDocStd_Document)& theDocument,
0063                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0064
0065   //! Writes a CAD file, according internal configuration
0066   //! @param[in] thePath path to the export CAD file
0067   //! @param[out] theShape shape to export
0068   //! @param[in] theWS current work session
0069   //! @param theProgress[in] progress indicator
0070   //! @return true if Write operation has ended correctly
0071   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
0072                                      const TopoDS_Shape& theShape,
0073                                      Handle(XSControl_WorkSession)& theWS,
0074                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0075
0076   //! Writes a CAD file, according internal configuration
0077   //! @param[in] thePath path to the export CAD file
0078   //! @param[out] theShape shape to export
0079   //! @param theProgress[in] progress indicator
0080   //! @return true if Write operation has ended correctly
0081   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
0082                                      const TopoDS_Shape& theShape,
0083                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0084
0085 public:
0086
0087   //! Gets CAD format name of associated provider
0088   //! @return provider CAD format
0089   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
0090
0091   //! Gets provider's vendor name of associated provider
0092   //! @return provider's vendor name
0093   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
0094 };
0095
0096 #endif // _RWPly_Provider_HeaderFile