dtk_Catiav4Reader.hpp

Go to the documentation of this file.

#ifndef _UTIL_G4R_READER_HPP_
#define _UTIL_G4R_READER_HPP_
 
#include "def/define.h"
#include "util/dtk_reader.hpp"
#include "util/error_dtk.hpp"
#include "util/util_geom_ptr_dtk.hpp"
 
class CatiaV4Reader : public Dtk_Reader
{
public:
    virtual ~CatiaV4Reader();
    static Dtk_bool Enable();
 
//Mandatory
//additionnal
//! \brief : Read analytic surface ( if available ) used to create the surface of Dtk_FacePtr
//! \param [in] inJele : ID of surface entity , obtain by  infos->get_ID() of the Dtk_SurfacePtr of Dtk_FacePtr
//!          [out] outSrf : Description of analytic surface found 
//!                     
//! \return  status Error 
//!            dtkErrorAPINotStarted  : DtkAPI not started
//!            dtkErrorUnavailableReader : CatiaV4 reader not enable
//!            dtkCatiaV4_3dReadBadEntityNumber : Bad input parameter :  inJele not a surface entity 
//!            dtkErrorAttributeNotFound : No analytic description available
//!            dtkErrorNotProcessed : unknown analytic description 
//! \remarks :
//!       surfaces analytics read are :
//!            -Plane (Dtk_PlaneSurface)
//!            -Sphere (Dtk_SphericalSurface)
//!            -Torus (Dtk_ToroidalSurface)
//!            -Cylindrical (Dtk_CylindricalSurface)
//!            -Conical (Dtk_ConicalSurface)
//!            
//! \b Sample: 
//! \code
//!      
//! 
//! 
//! \endcode
 static Dtk_ErrorStatus  ReadAnalyticDefinition(Dtk_ID inJele, Dtk_SurfacePtr &outSrf);
 
 //! [Options]
 //! \brief : Enable or disable conversion from MockUp Solid into a mesh solid 
 //! \param [in] inValue :  0 disable (default) ( MockUp Solid are a Dtk_Body ) 
 //!                        1 enable  ( MockUp SOlid are a Dtk_mesh )
 static void SetConfigMockUpAsMesh(int inValue );
 
//! \brief : Enable or disable conversion from nurbs surfaces to analytic surfaces if defined on the file 
//! \param [in] inValue :  0 disable (default) ( keep basic nurbs definition ) 
//!                        1 enable ( try to replace by analytic surface if stored on the file )
 static void SetConfigReadAnalyticSurface( int inValue );
 
 //! \brief : Enable or disable to order session tree according to CATIA V4 structure
//! \param [in] inValue :  0 disable (default) 
//!                        1 enable 
 static void SetConfigOrderedSessionTree( Dtk_Int32 inValue );
 
//! \brief : Set Preference to change Allow Invalid Catiav4 Files
//! \param [in] inValue :  0 Do not read invalid (default)
//!                        1 Allow read
 static void SetAllowCatiaV4ReadInvalidFiles( const Dtk_bool inValue );
//! [Options]
 
//! \brief : Internal use only - Enable or disable new color read method
static void EnableNewColorMethod();
static Dtk_bool checkNewColorMethod();
};
 
 
//! \brief Set Preference to change Allow Invalid Catiav4 Files
//! \param [in] inValue  1 Allow read,   0 Do not read invalid (default)
//! \deprecated : use static method CatiaV4Reader::SetAllowCatiaV4ReadInvalidFiles
SetAsDeprecated( "v2023.1", "Use CatiaV4Reader::SetAllowCatiaV4ReadInvalidFiles instead." )
void SetAllowCatiaV4ReadInvalidFiles_Deprecated231( const Dtk_bool inValue );
 
//! \brief : Enable or disable conversion from MockUp Solid into a mesh solid 
//! \deprecated : use static method CatiaV4Reader::SetConfigMockUpAsMesh
SetAsDeprecated( "v2023.1", "Use CatiaV4Reader::SetConfigMockUpAsMesh instead." )
void catiav4r_SetConfigMockUpAsMesh_Deprecated231(int ival);
 
//! \brief : Read analytic surface ( if available ) used to create the surface of Dtk_FacePtr
//! \remarks :
//! \deprecated : use static method CatiaV4Reader::ReadAnalyticDefinition       
SetAsDeprecated( "v2023.1", "Use CatiaV4Reader::ReadAnalyticDefinition instead." )
extern Dtk_ErrorStatus  CatiaV4ReadAnalyticDefinition_Deprecated231(Dtk_ID inJele,Dtk_SurfacePtr &outSrf);
 
 
#endif // of ifndef _UTIL_G4R_READER_HPP_