DATAKIT API  V2025.1
ObjReader Class Reference
+ Inheritance diagram for ObjReader:

Public Member Functions

virtual Dtk_ErrorStatus _ReadConnectedEntity (const Dtk_NodeConnectorPtr &inConnector, Dtk_tab< Dtk_EntityPtr > &outEntity)
 
Dtk_ErrorStatus ActivateReader ()
 
Dtk_ErrorStatus CreateDocument (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
 
virtual Dtk_ErrorStatus CreateDocumentGraphical (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
 
Dtk_ErrorStatus DesactivateReader ()
 
Dtk_ErrorStatus EndComponent (Dtk_ComponentPtr &inComponent)
 
Dtk_ErrorStatus EndPopulateComponentsTree ()
 
virtual Dtk_ErrorStatus GetAssociatedEntities (Dtk_Node &inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities)
 
virtual Dtk_ErrorStatus GetConnectorsPointingToThisComponent (Dtk_Component &inCompo, Dtk_tab< Dtk_NodeConnectorPtr > &outConnectedEntities)
 
virtual Dtk_ErrorStatus GetFilePreview (const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
 
Dtk_ErrorStatus GetFileVersion (const Dtk_string &inInputFile, Dtk_string &outVersion)
 
Dtk_Int32 GetVersion ()
 
 ObjReader ()
 
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 ReadAdditionalInfos (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
 
virtual Dtk_ErrorStatus ReadAdvancedFeature (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
 
Dtk_ErrorStatus ReadComponent (const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)
 
virtual Dtk_ErrorStatus ReadComponentGraphic (const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
 
Dtk_ErrorStatus ReadEntity (Dtk_Node &inNode, Dtk_EntityPtr &outEntity)
 
virtual ~ObjReader ()
 

Static Public Member Functions

static Dtk_bool Enable ()
 

Protected Member Functions

void _Init ()
 
void _Reset ()
 
Dtk_ErrorStatus _WriteInventoryInLogFile (Dtk_ID inID, int inNum, int *inCount, char **inEntitiesName)
 
void _WriteLogFile ()
 

Protected Attributes

Dtk_string _InputFile
 
FILE * _InputFilePtr
 

Constructor & Destructor Documentation

◆ ObjReader()

ObjReader::ObjReader ( )

◆ ~ObjReader()

virtual ObjReader::~ObjReader ( )
virtual

Member Function Documentation

◆ _Init()

void ObjReader::_Init ( )
protected

◆ _ReadConnectedEntity()

virtual Dtk_ErrorStatus Dtk_Reader::_ReadConnectedEntity ( const Dtk_NodeConnectorPtr inConnector,
Dtk_tab< Dtk_EntityPtr > &  outEntity 
)
virtualinherited

Reimplemented in GltfReader.

◆ _Reset()

void ObjReader::_Reset ( )
protected

◆ _WriteInventoryInLogFile()

Dtk_ErrorStatus Dtk_Reader::_WriteInventoryInLogFile ( Dtk_ID  inID,
int  inNum,
int *  inCount,
char **  inEntitiesName 
)
protectedinherited

◆ _WriteLogFile()

void ObjReader::_WriteLogFile ( )
protected

◆ ActivateReader()

Dtk_ErrorStatus ObjReader::ActivateReader ( )
virtual

Implements Dtk_Reader.

◆ CreateDocument()

Dtk_ErrorStatus ObjReader::CreateDocument ( const Dtk_string inInputFile,
Dtk_MainDocPtr outDocument 
)
virtual

Implements Dtk_Reader.

◆ CreateDocumentGraphical()

virtual Dtk_ErrorStatus Dtk_Reader::CreateDocumentGraphical ( const Dtk_string inInputFile,
Dtk_MainDocPtr outDocument 
)
virtualinherited

Reimplemented in ProeReader, and GltfReader.

◆ DesactivateReader()

Dtk_ErrorStatus ObjReader::DesactivateReader ( )
virtual

Implements Dtk_Reader.

◆ Enable()

static Dtk_bool ObjReader::Enable ( )
static

◆ EndComponent()

Dtk_ErrorStatus ObjReader::EndComponent ( Dtk_ComponentPtr inComponent)
virtual

Implements Dtk_Reader.

◆ EndPopulateComponentsTree()

Dtk_ErrorStatus ObjReader::EndPopulateComponentsTree ( )
virtual

Implements Dtk_Reader.

◆ GetAssociatedEntities()

virtual Dtk_ErrorStatus Dtk_Reader::GetAssociatedEntities ( Dtk_Node inNode,
Dtk_tab< Dtk_NodeConnectorPtr > &  outAssociatedEntities 
)
virtualinherited

Reimplemented in StepReader, SolidEdgeReader, ProeReader, JtReader, GltfReader, CreoviewReader, and BRepOccReader.

51  {
52  outAssociatedEntities.clear(); inNode.GetID(); return dtkErrorNotYetImplemented;};

◆ GetConnectorsPointingToThisComponent()

virtual Dtk_ErrorStatus Dtk_Reader::GetConnectorsPointingToThisComponent ( Dtk_Component inCompo,
Dtk_tab< Dtk_NodeConnectorPtr > &  outConnectedEntities 
)
virtualinherited

Reimplemented in StepReader, SolidEdgeReader, ProeReader, JtReader, GltfReader, CreoviewReader, and BRepOccReader.

53  {
54  outConnectedEntities.clear(); inCompo.GetID(); return dtkErrorNotYetImplemented;};

◆ GetFilePreview()

virtual Dtk_ErrorStatus Dtk_Reader::GetFilePreview ( const Dtk_string inInputFile,
Dtk_PreviewPtr outPreview 
)
virtualinherited

Reimplemented in SolidEdgeReader, ProeReader, and _3dmReader.

34  {DTK_UNUSED(inInputFile); outPreview = NULL; return dtkErrorNotYetImplemented;}

◆ GetFileVersion()

Dtk_ErrorStatus ObjReader::GetFileVersion ( const Dtk_string inInputFile,
Dtk_string outVersion 
)
virtual

Implements Dtk_Reader.

◆ GetVersion()

Dtk_Int32 ObjReader::GetVersion ( )
virtual

Implements Dtk_Reader.

◆ PopulateComponentsTree() [1/2]

Dtk_ErrorStatus ObjReader::PopulateComponentsTree ( const Dtk_string inInputFile,
Dtk_MainDocPtr inoutDocument,
Dtk_ComponentPtr outRootComponent 
)
virtual

Implements Dtk_Reader.

◆ PopulateComponentsTree() [2/2]

Dtk_ErrorStatus ObjReader::PopulateComponentsTree ( const Dtk_tab< Dtk_StreamPtr > &  inArrayStream,
Dtk_MainDocPtr inoutDocument,
Dtk_ComponentPtr outRootComponent 
)
virtual

Implements Dtk_Reader.

◆ ReadAdditionalInfos()

Dtk_ErrorStatus ObjReader::ReadAdditionalInfos ( Dtk_Node inNode,
Dtk_ObjectPtr outEntity 
)
virtual

Implements Dtk_Reader.

◆ ReadAdvancedFeature()

virtual Dtk_ErrorStatus Dtk_Reader::ReadAdvancedFeature ( Dtk_Node inNode,
Dtk_ObjectPtr outEntity 
)
virtualinherited

◆ ReadComponent()

Dtk_ErrorStatus ObjReader::ReadComponent ( const Dtk_ComponentPtr inComponent,
Dtk_NodePtr outRootNode 
)
virtual

Implements Dtk_Reader.

◆ ReadComponentGraphic()

virtual Dtk_ErrorStatus Dtk_Reader::ReadComponentGraphic ( const Dtk_ComponentPtr inComponent,
Dtk_GraphicalDataPtr outGraphicalData 
)
virtualinherited

◆ ReadEntity()

Dtk_ErrorStatus ObjReader::ReadEntity ( Dtk_Node inNode,
Dtk_EntityPtr outEntity 
)
virtual

Implements Dtk_Reader.

Field Documentation

◆ _InputFile

Dtk_string Dtk_Reader::_InputFile
protectedinherited

◆ _InputFilePtr

FILE* Dtk_Reader::_InputFilePtr
protectedinherited
dtkErrorNotYetImplemented
@ dtkErrorNotYetImplemented
Definition: error_dtk.hpp:32
Dtk_DocElement::GetID
Dtk_ID GetID() const
Retrieves the Dtk_DocElement ID - read only -.
Dtk_tab::clear
void clear(int no_delete=0)
Resets the Dtk_tab content.
Definition: util_stl_dtk.hpp:351
DTK_UNUSED
#define DTK_UNUSED(a)
Definition: define.h:730