catiav5w.hpp

Go to the documentation of this file.

#ifndef __DTK_CATIAV5W_H__
#define __DTK_CATIAV5W_H__
 
#include "def/define.h"
#include "struct/str_def.h"
 
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_metadata.hpp"
#include "util/BaseTypes/dtk_uuid.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/error_dtk.hpp"
 
#include "util/util_stl_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_ent_dtk.hpp"
//                    catiav5w.h                          //
 
 
 
namespace catiav5w
{
     typedef Dtk_tab< Dtk_ID > PathID;
     typedef Dtk_ID MaterialId;
 
     class WriteOptions
     {
     protected:
          Dtk_bool _WriteReferencePlanesAsHidden;
          Dtk_UChar8  _FileRelease;
     public:
          WriteOptions() : _WriteReferencePlanesAsHidden( 0 ), _FileRelease( 14 )
          {
          }
 
          ~WriteOptions()
          {
          }
 
          inline void WriteReferencePlaneAsHidden()
          {
               _WriteReferencePlanesAsHidden = DTK_TRUE;
          }
 
          inline void WriteReferencePlaneAsVisible()
          {
               _WriteReferencePlanesAsHidden = DTK_FALSE;
          }
 
          inline Dtk_bool AreReferencePlanesWrittenAsHidden() const
          {
               return _WriteReferencePlanesAsHidden;
          }
 
          Dtk_ErrorStatus SetFileRelease( const Dtk_UInt32 inRelease );
          inline Dtk_UInt32 GetFileRelease() const
          {
               return _FileRelease;
          }
          static Dtk_UInt32 GetMaximumFileReleaseHandled();
     };
 
     class Material
     {
     public:
          class Lighting
          {
          protected:
               Dtk_RGB                                 m_AmbientColor;
               Dtk_Double64                       m_AmbientCoefficient;
               Dtk_RGB                                 m_DiffuseColor;
               Dtk_Double64                       m_DiffuseCoefficient;
               Dtk_RGB                                 m_SpecularColor;
               Dtk_Double64                       m_SpecularCoefficient;
               Dtk_RGB                                 m_TransparencyColor;
               Dtk_Double64                       m_TransparencyCoefficient;
 
               Dtk_Double64                       m_ReflectivityCoefficient;
          public:
               Lighting()
               {
                    //default values
                    //No color
                    //No Coefficient
                    m_AmbientCoefficient = -1.0;
                    m_DiffuseCoefficient = -1.0;
                    m_SpecularCoefficient = -1.0;
                    m_TransparencyCoefficient = -1.0;
                    m_ReflectivityCoefficient = -1.0;
               }
               inline void SetAmbientData( const Dtk_RGB& inAmbientColor, const Dtk_Double64 inAmbientCoefficient )
               {
                    m_AmbientColor = inAmbientColor;
                    m_AmbientCoefficient = ( ( inAmbientCoefficient > 1. ) || ( inAmbientCoefficient < 0. ) ) ? 1. : inAmbientCoefficient;
               }
               inline void SetDiffuseData( const Dtk_RGB& inDiffuseColor, const Dtk_Double64 inDiffuseCoefficient )
               {
                    m_DiffuseColor = inDiffuseColor;
                    m_DiffuseCoefficient = ( ( inDiffuseCoefficient > 1. ) || ( inDiffuseCoefficient < 0. ) ) ? 1. : inDiffuseCoefficient;
               }
               inline void SetSpecularData( const Dtk_RGB& inSpecularColor, const Dtk_Double64 inSpecularCoefficient )
               {
                    m_SpecularColor = inSpecularColor;
                    m_SpecularCoefficient = ( ( inSpecularCoefficient > 1. ) || ( inSpecularCoefficient < 0. ) ) ? 0. : inSpecularCoefficient;
               }
               inline void SetTransparencyData( const Dtk_RGB& inTransparencyColor, const Dtk_Double64 inTransparencyCoefficient )
               {
                    m_TransparencyColor = inTransparencyColor;
                    m_TransparencyCoefficient = ( ( inTransparencyCoefficient > 1. ) || ( inTransparencyCoefficient < 0. ) ) ? 0. : inTransparencyCoefficient;
               }
               inline void SetReflectivityCoefficient( const Dtk_Double64 inReflectivityCoefficient )
               {
                    m_ReflectivityCoefficient = ( ( inReflectivityCoefficient > 1. ) || ( inReflectivityCoefficient < 0. ) ) ? 0. : inReflectivityCoefficient;
               }
               inline const Dtk_RGB& GetAmbientColor() const { return m_AmbientColor; }
               inline const Dtk_RGB& GetDiffuseColor() const { return m_DiffuseColor; }
               inline const Dtk_RGB& GetSpecularColor() const { return m_SpecularColor; }
               inline const Dtk_RGB& GetTransparencyColor() const { return m_TransparencyColor; }
               inline Dtk_Double64 GetAmbientCoefficient() const { return m_AmbientCoefficient; }
               inline Dtk_Double64 GetDiffuseCoefficient() const { return m_DiffuseCoefficient; }
               inline Dtk_Double64 GetSpecularCoefficient() const { return m_SpecularCoefficient; }
               inline Dtk_Double64 GetTransparencyCoefficient() const { return m_TransparencyCoefficient; }
               inline Dtk_Double64 GetReflectivityCoefficient() const { return m_ReflectivityCoefficient; }
          };
 
          class Analysis
          {
          protected:
               Dtk_Double64                       m_Density;
          public:
               Analysis()
               {
                    //default values
                    m_Density = -1.0; //default no density
               }
               inline void SetDensity( const Dtk_Double64 inDensity ) { m_Density = inDensity; }
               inline Dtk_Double64 GetDensity() const { return m_Density; }
          };
 
     public:
          Dtk_string                              m_Name;
          Lighting                           m_Lighting;
          Analysis                           m_Analysis;
     public:
 
          Material( const Dtk_string& inName = L"" )
          {
               m_Name = inName;
          }
     };
 
 
 
 
     class FileDescription
     {
     public:
 
          enum ProductSourceType
          {
               Unknown = 0,
               Made,
               Bought
          };
     protected:
 
          Material                      m_PartMaterial;
          Dtk_string                  _Revision;
          Dtk_string                  _Definition;
          Dtk_string                  _Nomenclature;
          Dtk_string                  _Description;
          ProductSourceType           _SourceType;
 
          Dtk_tab< Dtk_PropertiesPtr >    _AdditionalProperties;
 
          Dtk_Double64                _PartDensity;
 
     public:
 
          FileDescription()
          {
               _SourceType = Unknown; _PartDensity = -1.0;
          }
 
          ~FileDescription()
          {
          }
 
          inline void SetPartMaterial( const catiav5w::Material& inMaterial )
          {
               m_PartMaterial = inMaterial;
          }
 
          inline void SetRevision( const Dtk_string& inRevision )
          {
               _Revision = inRevision;
          }
 
          inline void SetDefinition( const Dtk_string& inDefinition )
          {
               _Definition = inDefinition;
          }
 
          inline void SetNomenclature( const Dtk_string& inNomenclature )
          {
               _Nomenclature = inNomenclature;
          }
 
          inline void SetDescription( const Dtk_string& inDescription )
          {
               _Description = inDescription;
          }
 
          inline void SetSourceType( const ProductSourceType& inSourceType )
          {
               _SourceType = inSourceType;
          }
 
          SetAsDeprecated( "2023.4", "Use SetPartMaterial with Analysis::Density instead." )
          inline void SetPartDensity( const Dtk_Double64 inPartDensity )
          {
               _PartDensity = inPartDensity;
          }
 
 
          inline void AddDoubleProperty( const Dtk_string& inPropertyName, const double& inValue )
          {
               Dtk_string TmpValue = inValue;
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsReal();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }
 
          inline void AddIntegerProperty( const Dtk_string& inPropertyName, const Dtk_Int32& inValue )
          {
               Dtk_string TmpValue;
               TmpValue.convert_from_int( inValue );
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsInteger();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }
 
 
          inline void AddBooleanProperty( const Dtk_string& inPropertyName, const Dtk_bool& inValue )
          {
               Dtk_string TmpValue;
               TmpValue.convert_from_int( inValue );
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetAsBoolean();
               TmpProp->SetValue( TmpValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }
 
          inline void AddStringProperty( const Dtk_string& inPropertyName, const Dtk_string& inValue )
          {
               Dtk_PropertiesPtr TmpProp = Dtk_Properties::create();
               TmpProp->SetTitle( inPropertyName );
               TmpProp->SetType( L"STRING" );
               TmpProp->SetValue( inValue );
 
               _AdditionalProperties.push_back( TmpProp );
          }
          inline const catiav5w::Material& GetPartMaterial() const
          {
               return m_PartMaterial;
          }
 
          inline const Dtk_string& GetRevision() const
          {
               return _Revision;
          }
 
          inline const Dtk_string& GetDefinition() const
          {
               return _Definition;
          }
 
          inline const Dtk_string& GetNomenclature() const
          {
               return _Nomenclature;
          }
 
          inline const Dtk_string& GetDescription() const
          {
               return _Description;
          }
 
          inline const ProductSourceType& GetSourceType() const
          {
               return _SourceType;
          }
 
          SetAsDeprecated( "2023.4", "Use GetPartMaterial method instead." )
          inline Dtk_Double64 GetPartDensity() const
          {
               return _PartDensity;
          }
 
          inline Dtk_Size_t GetNumAdditionalProperties() const
          {
               return _AdditionalProperties.size();
          }
 
          inline const Dtk_PropertiesPtr& GetIthAdditionalProperties( const Dtk_Size_t& inPos ) const
          {
               return _AdditionalProperties[ inPos ];
          }
 
     };
 
 
     enum NodeType
     {
          NodeTypeUnknown = 0,
          NodeTypeGeometricSet = 1,
          NodeTypePartBody = 2,//hybrid bodies
          NodeTypeMechanicalTool = 3,
     };
 
     Dtk_ErrorStatus InitWrite( const Dtk_string& inLogFile, Licence_dtk inLicFct, const WriteOptions& inOptions = WriteOptions() );
 
 
     Dtk_bool IsWriteInitialized();
 
     SetAsDeprecated( "2024.2", "Use Dtk_ErrorStatus catiav5w::InitPart( const Dtk_string&, const Dtk_string&, Dtk_UUID&, const catiav5w::FileDescription& ) method instead." )
     Dtk_UUID InitPart(
          const Dtk_string &inOutputFile,
          const Dtk_string& inReferenceName,
          const catiav5w::FileDescription& inFileDescription = catiav5w::FileDescription() );
 
     Dtk_ErrorStatus InitPart(
          const Dtk_string &inOutputFile,
          const Dtk_string& inReferenceName,
          Dtk_UUID& outPartUUID,
          const catiav5w::FileDescription& inFileDescription = catiav5w::FileDescription() );
 
     Dtk_ErrorStatus EndPart();
 
     Dtk_ErrorStatus EndWrite();
 
     Dtk_ErrorStatus WriteEntity( const Dtk_EntityPtr& inEntity );
 
     Dtk_ErrorStatus WriteNamedView( const Dtk_ModelDisplayPtr& inNamedView );
 
     Dtk_ErrorStatus CreateNode( const NodeType& inNodeType, const Dtk_string& inNodeName = Dtk_string() );
 
     Dtk_ErrorStatus CreateNode( const NodeType& inNodeType, const Dtk_InfoPtr& inInfos );
 
     Dtk_ErrorStatus CloseCurrentNode();
 
     Dtk_ErrorStatus AddDoubleParameter( const Dtk_string& inParameterName, const Dtk_Double64& inValue );
 
     Dtk_ErrorStatus AddIntegerParameter( const Dtk_string& inParameterName, const Dtk_Int32& inValue );
 
     Dtk_ErrorStatus AddBooleanParameter( const Dtk_string& inParameterName, const Dtk_bool& inValue );
 
     Dtk_ErrorStatus AddStringParameter( const Dtk_string& inParameterName, const Dtk_string& inValue );
 
 
     Dtk_ErrorStatus CreatePartDocId( const Dtk_string& inPartFileName,
                                              const Dtk_string& inPartName,
                                              Dtk_ID& outDocId );
 
     Dtk_ErrorStatus CreateProductDocId( const Dtk_string& inPartFileName,
                                                  const Dtk_string& inPartName,
                                                  Dtk_ID& outDocId );
 
     Dtk_ErrorStatus CreateCGRDocId( const Dtk_string& inCGRFileName,
                                             const Dtk_string& inCGRName,
                                             Dtk_ID& outDocId );
 
     Dtk_ErrorStatus CreateV4ModelDocId( const Dtk_string& inV4ModelFileName,
                                                  const Dtk_string& inV4ModelName,
                                                  Dtk_ID& outDocId );
 
     Dtk_ErrorStatus InitProduct(
          const Dtk_string& inFileName,
          const Dtk_string& inReferenceName,
          const catiav5w::FileDescription& inFileDescription = catiav5w::FileDescription() );
 
     Dtk_ErrorStatus EndProduct( Dtk_ID& outDocId );
 
     SetAsDeprecated( "2023.4", "Use catiav5w::AddInstance( const Dtk_ID&, const Dtk_string&, const Dtk_transfo&, Dtk_ID& ) method instead." )
     Dtk_ErrorStatus AddInstance( const Dtk_ID& inDocId,
                                         const Dtk_string& inInstanceName,
                                         const Dtk_transfo& inTransfo,
                                         const Dtk_bool inBlankedStatus = 0,
                                         const Dtk_RGB& inInstanceColorAlpha = Dtk_RGB() );
 
     Dtk_ErrorStatus AddInstance( const Dtk_ID& inDocId,
                                         const Dtk_string& inInstanceName,
                                         const Dtk_transfo& inTransfo,
                                         Dtk_ID& outInstanceId );
     Dtk_ErrorStatus InitVirtualComponent(
          const Dtk_string& inReferenceName,
          const catiav5w::FileDescription& inFileDescription = catiav5w::FileDescription() );
 
     Dtk_ErrorStatus EndVirtualComponent( Dtk_ID& outDocId );
 
     SetAsDeprecated( "2023.4", "Use catiav5w::AddVirtualComponentInstance( const Dtk_ID&, const Dtk_string&, const Dtk_transfo&, Dtk_ID& ) method instead." )
     Dtk_ErrorStatus AddVirtualComponentInstance( const Dtk_ID& inDocId,
                                                             const Dtk_string& inInstanceName,
                                                             const Dtk_transfo& inTransfo );
 
     Dtk_ErrorStatus AddVirtualComponentInstance( const Dtk_ID& inDocId,
                                                             const Dtk_string& inInstanceName,
                                                             const Dtk_transfo& inTransfo,
                                                             Dtk_ID& outInstanceId );
 
     Dtk_ErrorStatus OverrideBlankedStatusWithPathID( const PathID& inInstancePathId, const Dtk_bool inBlankedStatus );
 
     Dtk_ErrorStatus OverrideInstanceColorWithPathID( const PathID& inInstancePathId, const Dtk_RGB& inInstanceColor );
 
     Dtk_ErrorStatus OverrideInstanceAlphaWithPathID( const PathID& inInstancePathId, const Dtk_UChar8 inInstanceAlpha );
 
     Dtk_ErrorStatus SetLayerData( const Dtk_LayerInfosSetPtr& inLayerDataSet );
 
     SetAsDeprecated( "2024.2", "Use Dtk_ErrorStatus catiav5w::AddMaterial( const Material&, MaterialId& ) method instead." )
     MaterialId AddMaterial( const Material& inMaterial );
 
     Dtk_ErrorStatus AddMaterial( const Material& inMaterial, MaterialId& outMaterialId );
 
};
#endif
 
 
namespace Config
{
     namespace catiav5w
     {
          void SetWriteReferencePlanesAsHidden( const Dtk_bool& inVal );
          Dtk_bool GetWriteHybridBodies();
     }
}