EIC code displayed by LXR master/​include/​opencascade/​RWPly_ConfigurationNode.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:04:43

 // Copyright (c) 2022 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _RWPly_ConfigurationNode_HeaderFile
 #define _RWPly_ConfigurationNode_HeaderFile
 
 #include <DE_ConfigurationNode.hxx>
 #include <Precision.hxx>
 #include <RWMesh_CoordinateSystem.hxx>
 
 class DE_ConfigurationContext;
 
 //! The purpose of this class is to configure the transfer process for PLY format
 //! Stores the necessary settings for RWPly_Provider.
 //! Configures and creates special provider to transfer PLY files.
 //!
 //! Nodes grouped by Vendor name and Format type.
 //! The Vendor name is "OCC"
 //! The Format type is "PLY"
 //! The supported CAD extension is ".ply"
 //! The import process isn't supported.
 //! The export process is supported.
 class RWPly_ConfigurationNode : public DE_ConfigurationNode
 {
   DEFINE_STANDARD_RTTIEXT(RWPly_ConfigurationNode, DE_ConfigurationNode)
 public:
 
   //! Initializes all field by default
   Standard_EXPORT RWPly_ConfigurationNode();
 
   //! Copies values of all fields
   //! @param[in] theNode object to copy
   Standard_EXPORT RWPly_ConfigurationNode(const Handle(RWPly_ConfigurationNode)& theNode);
 
   //! Updates values according the resource
   //! @param[in] theResource input resource to use
   //! @return true if theResource loading has ended correctly
   Standard_EXPORT virtual bool Load(const Handle(DE_ConfigurationContext)& theResource) Standard_OVERRIDE;
 
   //! Writes configuration to the string
   //! @return result resource string
   Standard_EXPORT virtual TCollection_AsciiString Save() const Standard_OVERRIDE;
 
   //! Copies values of all fields
   //! @return new object with the same field values
   Standard_EXPORT virtual Handle(DE_ConfigurationNode) Copy() const Standard_OVERRIDE;
 
   //! Creates new provider for the own format
   //! @return new created provider
   Standard_EXPORT virtual Handle(DE_Provider) BuildProvider() Standard_OVERRIDE;
 
 public:
 
   //! Checks the import supporting
   //! @return true if import is supported
   Standard_EXPORT virtual bool IsImportSupported() const Standard_OVERRIDE;
 
   //! Checks the export supporting
   //! @return true if export is supported
   Standard_EXPORT virtual bool IsExportSupported() const Standard_OVERRIDE;
 
   //! Gets CAD format name of associated provider
   //! @return provider CAD format
   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
 
   //! Gets provider's vendor name of associated provider
   //! @return provider's vendor name
   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
 
   //! Gets list of supported file extensions
   //! @return list of extensions
   Standard_EXPORT virtual TColStd_ListOfAsciiString GetExtensions() const Standard_OVERRIDE;
 
   //! Checks the file content to verify a format
   //! @param[in] theBuffer read stream buffer to check content
   //! @return Standard_True if file is supported by a current provider
   Standard_EXPORT virtual bool CheckContent(const Handle(NCollection_Buffer)& theBuffer) const Standard_OVERRIDE;
 
 public:
   struct RWPly_InternalSection
   {
     // Common
     double FileLengthUnit = 1.; //!< File length units to convert from while reading the file, defined as scale factor for m (meters)
     RWMesh_CoordinateSystem SystemCS = RWMesh_CoordinateSystem_Zup; //!< System origin coordinate system to perform conversion into during read
     RWMesh_CoordinateSystem FileCS = RWMesh_CoordinateSystem_Yup; //!< File origin coordinate system to perform conversion during read
     // Writing
     bool WriteNormals = true; //!< Flag for write normals
     bool WriteColors = true; //!< Flag for write colors
     bool WriteTexCoords = false; //!< Flag for write UV / texture coordinates
     bool WritePartId = true; //!< Flag for write part Id as element attribute
     bool WriteFaceId = false; //!< Flag for write face Id as element attribute. Cannot be combined with HasPartId
     TCollection_AsciiString WriteComment; //!< Export special comment
     TCollection_AsciiString WriteAuthor; //!< Author of exported file name
   } InternalParameters;
 };
 
 #endif // _RWPly_ConfigurationNode_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team