SwReader Class Reference

Inheritance diagram for SwReader:

Public Member Functions
virtual Dtk_ErrorStatus	_ReadConnectedEntity (const Dtk_NodeConnectorPtr &inConnector, Dtk_tab< Dtk_EntityPtr > &outEntity)
virtual Dtk_ErrorStatus	ActivateReader ()=0
virtual Dtk_ErrorStatus	CreateDocument (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)=0
virtual Dtk_ErrorStatus	CreateDocumentGraphical (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
virtual Dtk_ErrorStatus	DesactivateReader ()=0
virtual Dtk_ErrorStatus	EndComponent (Dtk_ComponentPtr &inComponent)=0
virtual Dtk_ErrorStatus	EndPopulateComponentsTree ()=0
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)
virtual Dtk_ErrorStatus	GetFileVersion (const Dtk_string &inInputFile, Dtk_string &outVersion)=0
void *	GetSearchEngine ()
virtual Dtk_Int32	GetVersion ()=0
virtual Dtk_ErrorStatus	PopulateComponentsTree (const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
virtual Dtk_ErrorStatus	PopulateComponentsTree (const Dtk_tab< Dtk_StreamPtr > &inArrayStream, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)=0
virtual Dtk_ErrorStatus	ReadAdditionalInfos (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)=0
virtual Dtk_ErrorStatus	ReadAdvancedFeature (Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
virtual Dtk_ErrorStatus	ReadComponent (const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)=0
virtual Dtk_ErrorStatus	ReadComponentGraphic (const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
virtual Dtk_ErrorStatus	ReadEntity (Dtk_Node &inNode, Dtk_EntityPtr &outEntity)=0

Static Public Member Functions
static Dtk_bool	Enable ()
static Dtk_bool	GetComputeBoundariesFromMesh (void)
static Dtk_bool	GetConfigCreate2dCurvesOf3dGeometryForDrawings (void)
static Dtk_bool	GetConfigReadDrawingsWithGraphicRepresentation ()
	[Options] More...
static void	SetComputeBoundariesFromMesh (Dtk_bool inComputeBoundary)
	Forces computation of boundaries from mesh when reading SolidWorks 2D/3D files. More...
static void	SetConfigCreate2dCurvesOf3dGeometryForDrawings (Dtk_bool inCreateCurves)
	When reading a .SLDDRW file, determines whether curves in the 2D plane are created from 3D geometry (mesh/body). Enabled by default. More...
static void	SetConfigReadDrawingsWithGraphicRepresentation (const Dtk_bool readWithGraphicRepresentation)
	If true, reads the graphic representation in .SLDDRW files; if false, uses the semantic representation. More...

Protected Member Functions
void	_Init ()
void	_Reset ()
Dtk_ErrorStatus	_WriteInventoryInLogFile (Dtk_ID inID, int inNum, int *inCount, char **inEntitiesName)
	SwReader ()
virtual	~SwReader ()

Protected Attributes
Dtk_string	_InputFile
FILE *	_InputFilePtr

Constructor & Destructor Documentation

SwReader()

SwReader::SwReader ( )

protected

~SwReader()

virtual SwReader::~SwReader ( )

protectedvirtual

Member Function Documentation

_Init()

void Dtk_Reader::_Init ( )

protectedinherited

_ReadConnectedEntity()

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

virtualinherited

Reimplemented in GltfReader.

_Reset()

void Dtk_Reader::_Reset ( )

protectedinherited

_WriteInventoryInLogFile()

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

protectedinherited

ActivateReader()

virtual Dtk_ErrorStatus Dtk_Reader::ActivateReader ( )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

CreateDocument()

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

CreateDocumentGraphical()

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

virtualinherited

Reimplemented in ProeReader, and GltfReader.

DesactivateReader()

virtual Dtk_ErrorStatus Dtk_Reader::DesactivateReader ( )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

Enable()

static Dtk_bool SwReader::Enable ( )

static

EndComponent()

virtual Dtk_ErrorStatus Dtk_Reader::EndComponent ( Dtk_ComponentPtr &  inComponent )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

EndPopulateComponentsTree()

virtual Dtk_ErrorStatus Dtk_Reader::EndPopulateComponentsTree ( )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

GetAssociatedEntities()

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

virtualinherited

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

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

GetComputeBoundariesFromMesh()

static Dtk_bool SwReader::GetComputeBoundariesFromMesh ( void  )

static

Returns

[Deprecated] Indicates whether boundaries are computed from mesh when reading SolidWorks 2D/3D files.

Warning

Call after Dtk_API initialization.

GetConfigCreate2dCurvesOf3dGeometryForDrawings()

static Dtk_bool SwReader::GetConfigCreate2dCurvesOf3dGeometryForDrawings ( void  )

static

Returns

[Deprecated] Indicates whether curves in the 2D plane are created from 3D geometry (mesh/body) when reading .SLDDRW files.

Warning

Call after Dtk_API initialization.

GetConfigReadDrawingsWithGraphicRepresentation()

static Dtk_bool SwReader::GetConfigReadDrawingsWithGraphicRepresentation ( )

static

[Options]

Returns

Indicates whether the graphic or semantic representation is used when reading .SLDDRW files.

Warning

Call after Dtk_API initialization.

GetConnectorsPointingToThisComponent()

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

virtualinherited

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

                                                                                                                                             { 
               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.

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

GetFileVersion()

virtual Dtk_ErrorStatus Dtk_Reader::GetFileVersion ( const Dtk_string &  inInputFile, Dtk_string &  outVersion  )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

GetSearchEngine()

void* SwReader::GetSearchEngine

(

)

GetVersion()

virtual Dtk_Int32 Dtk_Reader::GetVersion ( )

pure virtualinherited

Implemented in XmlReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

PopulateComponentsTree() [1/2]

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

PopulateComponentsTree() [2/2]

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadAdditionalInfos()

virtual Dtk_ErrorStatus Dtk_Reader::ReadAdditionalInfos ( Dtk_Node &  inNode, Dtk_ObjectPtr &  outEntity  )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadAdvancedFeature()

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

virtualinherited

ReadComponent()

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

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

ReadComponentGraphic()

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

virtualinherited

Reimplemented in StlReader, ProeReader, GltfReader, FbxReader, and CreoviewReader.

ReadEntity()

virtual Dtk_ErrorStatus Dtk_Reader::ReadEntity ( Dtk_Node &  inNode, Dtk_EntityPtr &  outEntity  )

pure virtualinherited

Implemented in XmlReader, U3dReader, StlReader, StepReader, SolidEdgeReader, RnXmlReader, ProeReader, ProCeraReader, PlmXmlReader, PdfReader, ObjReader, LavaReader, IfcReader, GltfReader, FbxReader, DcmReader, CreoviewReader, CerecReader, CerconReader, CaddsReader, BRepOccReader, _3dxml_Namespace::_3DXmlReader, and _3dmReader.

SetComputeBoundariesFromMesh()

static void SwReader::SetComputeBoundariesFromMesh ( Dtk_bool  inComputeBoundary )

static

Forces computation of boundaries from mesh when reading SolidWorks 2D/3D files.

[Options]

Parameters

inComputeBoundary

DTK_TRUE to compute boundaries from mesh when reading SolidWorks 2D/3D files. Default is DTK_FALSE.

Warning

Call after Dtk_API initialization and before Dtk_API::OpenDocument.

SetConfigCreate2dCurvesOf3dGeometryForDrawings()

static void SwReader::SetConfigCreate2dCurvesOf3dGeometryForDrawings ( Dtk_bool  inCreateCurves )

static

When reading a .SLDDRW file, determines whether curves in the 2D plane are created from 3D geometry (mesh/body). Enabled by default.

Parameters

inCreateCurves

DTK_TRUE to create curves in the 2D plane from 3D geometry (mesh/body) when reading .SLDDRW files. Default is DTK_TRUE.

Warning

Call after Dtk_API initialization and before Dtk_API::OpenDocument.

SetConfigReadDrawingsWithGraphicRepresentation()

static void SwReader::SetConfigReadDrawingsWithGraphicRepresentation ( const Dtk_bool  readWithGraphicRepresentation )

static

If true, reads the graphic representation in .SLDDRW files; if false, uses the semantic representation.

Parameters

readWithGraphicRepresentation

DTK_TRUE to use graphic representation, DTK_FALSE to use semantic representation. Default is DTK_TRUE.

Warning

Call after Dtk_API initialization.

Field Documentation

_InputFile

Dtk_string Dtk_Reader::_InputFile

protectedinherited

_InputFilePtr

FILE* Dtk_Reader::_InputFilePtr

protectedinherited