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 GetFileVersion( const Dtk_string& inInputFile, Dtk_string& outVersion );
 
     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 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();
 
 
     //  ====    Specific settings for STEP Read    ====
     static Dtk_ErrorStatus SetParseMode( const int inModeReader );
 
     static Dtk_ErrorStatus SetComponentNameMode( const int inModeName );
 
     SetAsDeprecated( "2025.4", "Use StepReader::SetModeFDTRepresentation method instead." )
     static Dtk_ErrorStatus SetModeReadFDT( const int inMode );
 
     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.
     };
     static Dtk_ErrorStatus SetModeFDTRepresentation( FDTRepresentation );
 
     static Dtk_ErrorStatus SetModeProperty( const int inModeProp, const int inModeValProp = 0 );
 
     static Dtk_ErrorStatus SetReadExtendedAsciiMode( const int inMode );
 
     static Dtk_ErrorStatus SetModeColorUnlisted( const int inMode );
 
     static Dtk_ErrorStatus SetModeOrphanBody( const int inMode );
 
     static Dtk_ErrorStatus SetModePropagateColor( const Dtk_bool inMode );
 
     static Dtk_ErrorStatus SetLayerDescriptionMode( const Dtk_bool inMode );
 
     static Dtk_ErrorStatus SetAllowReadInvalidFiles( const Dtk_bool inMode );
 
     //  ====    Fields and internal actions    ====
 
protected:
 
     class StepReader_Handle;
     StepReader_Handle* _Private;
 
     void _Init();
     Dtk_ErrorStatus InitReader( const Dtk_string& inInputFile );
 
};
 
#endif