dtk_StepReader.hpp

Go to the documentation of this file.

/**********************************************************
   STR_VR.H
***********************************************************/
#ifndef _DTK_STEP_READER_H_
#define _DTK_STEP_READER_H_
#include "util/dtk_reader.hpp"
#include "def/define.h"
 
class StepReader : public Dtk_Reader
{
public:
 
     StepReader();
     virtual ~StepReader();
 
     static Dtk_bool Enable();
 
     //  ====    General inherited actions    ====
     Dtk_ErrorStatus CreateDocument( const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument );
     Dtk_ErrorStatus CreateDocumentGraphical( const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument );
     Dtk_ErrorStatus GetFileVersion( const Dtk_string& inInputFile, Dtk_string& outVersion );
     Dtk_ErrorStatus GetFilePreview( const Dtk_string& inInputFile, Dtk_PreviewPtr& outPreview );
 
     Dtk_ErrorStatus PopulateComponentsTree( const Dtk_string& inInputFile, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
     Dtk_ErrorStatus PopulateComponentsTree( const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
     Dtk_ErrorStatus EndPopulateComponentsTree();
 
     Dtk_ErrorStatus ReadComponent( const Dtk_ComponentPtr& inComponent, Dtk_NodePtr& outRootNode );
     Dtk_ErrorStatus ReadComponentGraphic( const Dtk_ComponentPtr& inComponent, Dtk_GraphicalDataPtr& outGraphicalData );
     Dtk_ErrorStatus EndComponent( Dtk_ComponentPtr& inComponent );
 
     Dtk_ErrorStatus ReadEntity( Dtk_Node& inNode, Dtk_EntityPtr& outEntity );
     Dtk_ErrorStatus ReadAdditionalInfos( Dtk_Node& inNode, Dtk_ObjectPtr& outEntity );
 
     Dtk_ErrorStatus GetConnectorsPointingToThisComponent( Dtk_Component& inCompo, Dtk_tab<Dtk_NodeConnectorPtr>& outConnectedEntities );
     Dtk_ErrorStatus GetAssociatedEntities( Dtk_Node& inNode, Dtk_tab< Dtk_NodeConnectorPtr >& outAssociatedEntities );
 
     Dtk_ErrorStatus ActivateReader();
     Dtk_ErrorStatus DesactivateReader();
 
     Dtk_Int32 GetVersion();
 
     //! [Options] 
     //  ====    Specific settings for STEP Read    ====
     //! \ingroup step
     //! \brief Select Parsing Mode on Reading
     //! \param [in] inModeReader : 1 to use Datakit parser with full computation, 2 to use Datakit parser with light computation.
     //! \remark Default mode is 1.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetParseMode( const int inModeReader );
 
     //! \ingroup step
     //! \brief Select Mode to give priority to specific STEP PRODUCT fields for Dtk_Component naming
     //! \param [in] inModeReader : 0 to consider only PRODUCT.ID, 1 to give priority to PRODUCT.ID, over PRODUCT.NAME (if not empty), 2 to give priority to PRODUCT.NAME, over PRODUCT.ID (if not empty), 3 to concatenate PRODUCT.ID and PRODUCT.NAME (if different)
     //! \remark Default mode is 1.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetComponentNameMode( const int inModeName );
 
 
     enum class FDTRepresentation
     {
          GraphicalOnly = 0,
          SemanticWithFrozenGraphicPriority = 1, //In cases where multiple graphical representation exist for a same FDT, give priority to the purely graphical one.
          SemanticWithPlaceholderPriority = 2 //In cases where multiple graphical representation exist for a same FDT, give priority to the placeholder one.
     };
     //! \ingroup step
     //! \brief Choose a representation mode for FDT. See FDTRepresentation enum for more details.
     //! \param The desired FDTRepresentation
     //! \remark "Placeholder" is a notion introduced in AP242E3, allowing to represent FDT graphics with light and minimal information. The receiving system is in charge of recreated the graphics based on those information.
     //! \remark Default mode is SemanticWithFrozenGraphicPriority.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetModeFDTRepresentation( FDTRepresentation );
 
     //! \ingroup step
     //! \brief Set Mode to read properties and attributes (PROPERTY_DEFINITION), and to compute Validation Properties when present (result in the log file).
     //! \param [in] inModeProp : 0 to deactivate properties reading (default), 1 to read properties and record them in Dtk_Info, 2 to also read properties concerning Dtk_Component and record them as Dtk_Metadata, 3 to also read properties concerning Dtk_Component and record them both in Dtk_Info and as Dtk_Metadata
     //! \param [in] inModeValProp optional : 0 to deactivate validation properties computation (default), 1 to compute only light validation properties (counts), 2 to compute also geometry-based validation properties (volume, area, center), 3 to compute cloud-of-points-based validation properties.
     //! \remark Computation of validation properties can be CPU consuming, that's why several levels of computation are proposed
     //! \remark Default mode for properties is 0. Default mode for validation properties is 0.
     //! //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetModeProperty( const int inModeProp, const int inModeValProp = 0 );
 
     //! \ingroup step
     //! \brief Set mode to choose the code page or encoding to be used in case of non-standard ASCII characters encountered
     //! \param [in] inModeExtAscii : 0 to use UTF-8, 1 to use code page 936 (Microsfot Windows, simplified chinese), 2 to use code page 855 (Cyrillic).
     //! \remark These characters are NOT ALLOWED, but some writers can use them anyway.
     //! \remark Default mode is 0.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetReadExtendedAsciiMode( const int inMode );
 
     //! \ingroup step
     //! \brief Set Mode to read colors not correctly defined (that is, not in a list).
     //! \param [in] inMode : 0 to ignore them, 1 to ignore them only if some colors are correctly defined, 2 to read them all.
     //! \remark Default mode is 0.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetModeColorUnlisted( const int inMode );
 
     //! \ingroup step
     //! \brief Set Mode to read orphan bodies (not belonging to a product), depending on the product structure of the STEP file.
     //! \param [in] inMode : 0 to ingore them , 1 to ignore them only if no product is defined, 2 to ignore them only if no product is defined, or several products are defined but no assembly, 3 to read them all.
     //! \remark Default mode is 0.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetModeOrphanBody( const int inMode );
 
     //! \ingroup step
     //! \brief Set Mode to propagate colors of a body (solid, surfacic ..) to its faces.
     //! \param [in] inMode : DTK_TRUE to allow propagation, DTK_FALSE otherwise.
     //! \remark Default mode is DTK_TRUE.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetModePropagateColor( const Dtk_bool inMode );
 
     //! \ingroup step
     //! \brief Select Mode to get Description of Layer added to its name.
     //! \param [in] inModeLayerName : DTK_FALSE to deactivate this mode, DTK_TRUE otherwise.
     //! \remark When active, a LayerInfoSet is created with a Layer Filter per Layer, with its name and description, if not empty
     //! \remark Default mode is DTK_FALSE.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetLayerDescriptionMode( const Dtk_bool inMode );
 
     //! \ingroup step
     //! \brief Define if we should try to process potentially corrupted file.
     //! \param [in] inMode DTK_TRUE to allow invalid file reading, DTK_FALSE otherwise.
     //! \remark Default mode is DTK_FALSE.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static Dtk_ErrorStatus SetAllowReadInvalidFiles( const Dtk_bool inMode );
     //! [Options] 
 
     //! \ingroup step
     //! \brief Activates/Deactivates Reading of FDT
     //! \param [in] inMode : 1 to read only FDT graphical information, 2 to read fully semantic FDT, and give priorirty to "frozen" graphics (3D tessellation, polylines), 3 to read fully semantic and give priorirty to the "placeholder" graphics
     //! \remark "Placeholder" is a notion introduced in AP242E3, allowing to represent FDT graphics with light and minimal information. The receiving system is in charge of recreated the graphics based on those information.
     //! \remark Default mode is 2.
     //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     //! \deprecated Use StepReader::SetModeFDTRepresentation method instead.
     SetAsDeprecated( "2025.4", "Use StepReader::SetModeFDTRepresentation method instead." )
          static Dtk_ErrorStatus SetModeReadFDT( const int inMode );
 
     //  ====    Fields and internal actions    ====
 
protected:
 
     class StepReader_Handle;
     StepReader_Handle* _Private;
 
     Dtk_ErrorStatus InitReader( const Dtk_string& inInputFile );
 
};
 
#endif