Dtk_API Class Reference

Public Member Functions
void	ActivateDialogBox ()
void	ActivateFeaturesRead (Dtk_Int32 inForceFeatureData=DTK_FALSE)
	Activate Features read. More...
void	ActivateKeepKernelData ()
	Keep Kernel Data option (see "How to use KeepKernelData option") More...
void	ActivateNewFdtRead ()
	From V73 Activate New Fdt read (One Dtk_Node per FDT) More...
void	ActivateReversedRevolution ()
	From V66 Use old way to read Revolution Surface. More...
void	ActivateSearchFileEngine ()
void	ActivateSplitForMultiTurnsFaces ()
	Split Multi Turns Faces when we read a model. More...
void	ActivateSplitForPeriodicFaces ()
	Split Periodic Faces when we read a model. More...
Dtk_ID	AddBuildingMaterialInTable (const Dtk_BuildingMaterialPtr &inNewBuildingMaterial)
Dtk_ID	AddCurveLineTypeDefinitionInTable (const Dtk_LineTypeDefinitionPtr &inNewLineTypeDefinition)
Dtk_ErrorStatus	AddEvaluationID (Dtk_string inEvaluationID)
	Add customer Id for evaluation. More...
Dtk_ID	AddMaterialInTable (const Dtk_RenderInfosPtr &inNewRenderInfos)
Dtk_ID	AddPhysicalMaterialInfosInTable (const Dtk_PhysicalMaterialInfosPtr &inNewMaterialInfos)
Dtk_ID	AddRenderInfosInTable (const Dtk_RenderInfosPtr &inNewRenderInfos)
Dtk_ErrorStatus	AddSearchPath (const Dtk_SearchFileEnum::RecursivityEnum &inRecursivityEnum, const Dtk_string &inPath)
	Add search path to find missing files. More...
Dtk_ErrorStatus	AddSearchPathForAssembly (Dtk_string &inPath, Dtk_bool inRecursiveFlag)
	Add search path to find missing files of assemblies. More...
Dtk_ErrorStatus	AddSearchPathForFonts (const Dtk_string &inPath)
	Add search path to find fonts. More...
void	BreakApi ()
Dtk_ErrorStatus	ClearSearchPathForAssembly ()
	Clear Search Path initialised with AddSearchPathForAssembly. More...
Dtk_ErrorStatus	ClearSearchPathForFonts ()
	Clear Search Path initialised with AddSearchPathForFonts. More...
Dtk_ErrorStatus	ClearSearchPriority ()
	Clear Search Priority. More...
void	DeactivateSearchFileEngine ()
void	DesactivateDrawingRead ()
	Desactivate Drawing read. More...
Dtk_ErrorStatus	EndComponent (Dtk_ComponentPtr &inComponent)
	EndComponent. More...
Dtk_ErrorStatus	EndDocument (Dtk_MainDocPtr &inoutDocument)
	Close a Document. More...
void	ForceUpdateAssembly ()
	Force to update the intern assembly definition by extern definition. More...
dtk_BodyMode	GetBodyModePreference ()
Dtk_BuildingMaterialPtr	GetBuildingMaterialInTable (Dtk_ID inId) const
Dtk_ErrorStatus	GetColorInTable (const Dtk_Int32 inIndex, Dtk_RGB &outColor)
	GetColor in API Lut form index. More...
Dtk_ColorTable *	GetColorTable ()
Dtk_Config *	GetConfig ()
Dtk_LineTypeDefinitionPtr	GetCurveLineTypeDefinitionInTable (const Dtk_ID inId) const
Dtk_ErrorStatus	GetFilePreview (const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
	Independant method to get preview of inInputFile. More...
DtkReaderType	GetFileReaderType (const Dtk_string &inFileName)
	Independant method to get DtkReaderType associated to inFileName. More...
Dtk_ErrorStatus	GetFileVersion (const Dtk_string &inInputFile, Dtk_string &outVersion)
	Independant method to get version of inInputFile. More...
Dtk_ErrorStatus	GetInvalidLicenseList (Dtk_tab< Dtk_string > &outList)
	Returns List of Failed Licence ever checked. More...
const Dtk_LogPtr &	GetLog ()
const Dtk_string &	GetLogFile () const
Dtk_RenderInfosPtr	GetMaterialInTable (Dtk_ID inId) const
Dtk_Size_t	GetNumBuildingMaterialInTable () const
Dtk_Size_t	GetNumColorInTable () const
	Get Number of Colors in API Lut More...
Dtk_Size_t	GetNumCurveLineTypeDefinitionsInTable () const
Dtk_Size_t	GetNumMaterialInTable () const
Dtk_Size_t	GetNumPhysicalMaterialInfosInTable () const
Dtk_Size_t	GetNumRenderInfosInTable () const
Dtk_PhysicalMaterialInfosPtr	GetPhysicalMaterialInfosInTable (Dtk_ID inId) const
Dtk_RenderInfosPtr	GetRenderInfosInTable (Dtk_ID inId) const
const Dtk_string &	GetSchemaDir () const
Dtk_ErrorStatus	GetSearchPathForAssembly (Dtk_tab< Dtk_string > &outPathArray, Dtk_tab< Dtk_bool > &outRecursiveFlagArray) const
Dtk_ErrorStatus	GetSearchPathForFonts (Dtk_tab< Dtk_string > &outPathArray) const
Dtk_string	GetVersion () const
	GetVersion of DatakitLibs. More...
const Dtk_string &	GetWorkingDir () const
Dtk_bool	IsBroken ()
Dtk_bool	IsDialogBoxActivated ()
Dtk_bool	IsExtraControlEnable ()
Dtk_bool	IsNewFdtReadActivated ()
Dtk_bool	IsReversedRevolutionActivated ()
Dtk_bool	IsSearchFileEngineActivated ()
Dtk_ErrorStatus	LoadConfigFile (const Dtk_string &inConfigFile)
Dtk_ErrorStatus	LoadConfigFile (FILE *inConfigFile)
void	ManageSearchFile (Dtk_SearchFileEnum::Status inStatus)
Dtk_ErrorStatus	OpenDocument (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
	Open a Document (call EndDocument to close it) More...
Dtk_ErrorStatus	OpenDocumentGraphic (const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
	Open a Document for graphical representation(call EndDocument to close it) More...
Dtk_ErrorStatus	PopulateComponentsTree (const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)
Dtk_ErrorStatus	ReadComponent (const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)
	Read Component from Assembly Tree (Call EndComponent to free data allocated) More...
Dtk_ErrorStatus	ReadComponentGraphic (const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
	Read graphical data from Component (Call EndComponent to free data allocated) More...
Dtk_ErrorStatus	ReadConnectedEntity (const Dtk_MainDocPtr &inDoc, const Dtk_NodeConnectorPtr &inConnector, Dtk_tab< Dtk_EntityPtr > &outEntity)
	Internal Use. More...
void	SetAbovePathSearchFlag (Dtk_bool inActivationFlag)
	Allow Above Search for files of assembly. More...
void	SetAdditionnalPathSearchFlag (Dtk_bool inActivationFlag)
	Allow Additionnal Path Search for files of assembly. More...
void	SetBelowPathSearchFlag (Dtk_bool inActivationFlag)
	Allow Below Search for files of assembly. More...
void	SetBodyModePreference (dtk_BodyMode inMode)
	Set Body Topology Preference. More...
void	SetControlOnExtraModule (Dtk_bool inControl)
	Disable/Enable Control for extra module. More...
void	SetInternalReadPathSearchFlag (Dtk_bool inActivationFlag)
	Allow Internal Read Path Search for files of assembly. More...
void	SetLocalPathSearchFlag (Dtk_bool inActivationFlag)
	Allow Local Path Search for files of assembly. More...
Dtk_ErrorStatus	SetLogFile (const Dtk_string &inLogFile)
	Set Log File. More...
void	SetReadCustomAttribut (Dtk_bool bRead)
	read customers attribut More...
void	SetRelativePathSearchFlag (Dtk_bool inActivationFlag)
	Allow Relative Search for files of assembly. More...
Dtk_ErrorStatus	SetSchemaDir (const Dtk_string &inSchemaDir)
	Set Schema Directory needed for Unigraphics, Parasolid, Solidedge, Solidworks and Jt readers. More...
Dtk_ErrorStatus	SetSearchPositionMode (Dtk_Int32 inPosition, Dtk_SearchFileEnum::PriorityModeEnum inSearchEnum)
	Set Search Position. More...
Dtk_ErrorStatus	SetWorkingDir (const Dtk_string &inWorkingDir)
	Change TemporyDirectory. More...
Dtk_ErrorStatus	WriteInDebugFile (const Dtk_string &inString)
Dtk_ErrorStatus	WriteInLogFile (const char *inString)
Dtk_ErrorStatus	WriteInLogFile (const Dtk_string &inString)

Static Public Member Functions
static void	DeactivateFlexlmCall ()
	Deactivate FlexlmCall. More...
static Dtk_API *	GetAPI ()
	Get DATAKIT API. More...
static Dtk_API *	StartAPI (const Dtk_string &inTemporyDirectory, Dtk_ErrorStatus &outErrorCode, const Dtk_string &inCustomerID=Dtk_string())
	Start DATAKIT API. More...
static void	StopAPI (Dtk_API *&inAPI, Dtk_bool inWriteTimeInLog=1)
	Stop DATAKIT API. More...

Protected Member Functions
void	_Init ()
Dtk_ErrorStatus	_InitData (const Dtk_string &inTemporyDirectory, const Dtk_string &inClientCode)
void	_Reset ()
	Dtk_API ()
virtual	~Dtk_API ()

Protected Attributes
Dtk_Handle *	_Private

Static Protected Attributes
static Dtk_Reader *	_3dmReader
static Dtk_Reader *	_AcisReader
static Dtk_Reader *	_ArtReader
static Dtk_Reader *	_BRepOccReader
static Dtk_Reader *	_CaddsReader
static Dtk_Reader *	_CerconReader
static Dtk_Reader *	_CerecReader
static Dtk_Reader *	_CgmReader
static Dtk_Reader *	_CgrReader
static Dtk_Reader *	_CreoviewReader
static Dtk_API *	_CurrentAPI
static Dtk_Reader *	_DcmReader
static Dtk_Reader *	_DstvReader
static Dtk_Reader *	_DwgDtkReader
static Dtk_Reader *	_DwgReader
static Dtk_Reader *	_DxfReader
static Dtk_Reader *	_F3dReader
static Dtk_Reader *	_FbxReader
static Dtk_Reader *	_GltfReader
static Dtk_Reader *	_IfcReader
static Dtk_Reader *	_IgesReader
static Dtk_Reader *	_InvReader
static Dtk_Reader *	_JtReader
static Dtk_Reader *	_Lava3mReader
static Dtk_Reader *	_NavisReader
static Dtk_Reader *	_ObjReader
static Dtk_Reader *	_PlmXmlReader
static Dtk_Reader *	_PrcReader
static Dtk_Reader *	_ProCeraReader
static Dtk_Reader *	_ProeReader
static Dtk_Reader *	_QifReader
static Dtk_Reader *	_RevitReader
static Dtk_Reader *	_RnXmlReader
static Dtk_Reader *	_SdnfReader
static Dtk_Reader *	_SeReader
static Dtk_Reader *	_SmgReader
static Dtk_Reader *	_StepReader
static Dtk_Reader *	_StlReader
static Dtk_Reader *	_SwReader
static Dtk_Reader *	_UgReader
static Dtk_Reader *	_V4Reader
static Dtk_Reader *	_V5Reader
static Dtk_Reader *	_V6Reader
static Dtk_Reader *	_VdaReader
static Dtk_Reader *	_XmlReader
static Dtk_Reader *	_XmtReader
static Dtk_Reader *	_Zw3dReader

Friends
class	_3dmReader
class	AcisReader
class	ArtReader
class	BRepOccReader
class	CaddsReader
class	CatiaV4Reader
class	CatiaV5Reader
class	CatiaV6Reader
class	CerconReader
class	CerecReader
class	CgmReader
class	CgrReader
class	CreoviewReader
class	DcmReader
class	DstvReader
class	Dtk_APIContext
class	Dtk_Component
class	Dtk_MainDocWrapper
class	Dtk_Node
class	DwgDtkReader
class	DwgReader
class	DxfReader
class	F3dReader
class	FbxReader
class	GltfReader
class	IfcReader
class	IgesReader
class	InvReader
class	JtReader
class	LavaReader
class	NavisReader
class	ObjReader
class	PlmXmlReader
class	PrcReader
class	ProCeraReader
class	ProeReader
class	PsReader
class	QifReader
class	RevitReader
class	RnXmlReader
class	SdnfReader
class	SeReader
class	SmgReader
class	SolidEdgeReader
class	StepReader
class	StlReader
class	SwReader
class	UgReader
class	VdaReader
class	XmlReader
class	XmtReader
class	Zw3dReader

Constructor & Destructor Documentation

Dtk_API()

Dtk_API::Dtk_API ( )

protected

~Dtk_API()

virtual Dtk_API::~Dtk_API ( )

protectedvirtual

Member Function Documentation

_Init()

void Dtk_API::_Init ( )

protected

_InitData()

Dtk_ErrorStatus Dtk_API::_InitData ( const Dtk_string &  inTemporyDirectory, const Dtk_string &  inClientCode  )

protected

_Reset()

void Dtk_API::_Reset ( )

protected

ActivateDialogBox()

void Dtk_API::ActivateDialogBox

(

)

ActivateFeaturesRead()

void Dtk_API::ActivateFeaturesRead

(

Dtk_Int32

inForceFeatureData = DTK_FALSE

)

Activate Features read.

ActivateKeepKernelData()

void Dtk_API::ActivateKeepKernelData

(

)

Keep Kernel Data option (see "How to use KeepKernelData option")

ActivateNewFdtRead()

void Dtk_API::ActivateNewFdtRead

(

)

From V73 Activate New Fdt read (One Dtk_Node per FDT)

ActivateReversedRevolution()

void Dtk_API::ActivateReversedRevolution

(

)

From V66 Use old way to read Revolution Surface.

ActivateSearchFileEngine()

void Dtk_API::ActivateSearchFileEngine

(

)

ActivateSplitForMultiTurnsFaces()

void Dtk_API::ActivateSplitForMultiTurnsFaces

(

)

Split Multi Turns Faces when we read a model.

ActivateSplitForPeriodicFaces()

void Dtk_API::ActivateSplitForPeriodicFaces

(

)

Split Periodic Faces when we read a model.

AddBuildingMaterialInTable()

Dtk_ID Dtk_API::AddBuildingMaterialInTable

(

const Dtk_BuildingMaterialPtr &

inNewBuildingMaterial

)

AddCurveLineTypeDefinitionInTable()

Dtk_ID Dtk_API::AddCurveLineTypeDefinitionInTable

(

const Dtk_LineTypeDefinitionPtr &

inNewLineTypeDefinition

)

AddEvaluationID()

Dtk_ErrorStatus Dtk_API::AddEvaluationID

(

Dtk_string

inEvaluationID

)

Add customer Id for evaluation.

Parameters

[in]

inEvaluationID

: Additionnal ID .

Returns

dtkNoError if OK

AddMaterialInTable()

Dtk_ID Dtk_API::AddMaterialInTable

(

const Dtk_RenderInfosPtr &

inNewRenderInfos

)

AddPhysicalMaterialInfosInTable()

Dtk_ID Dtk_API::AddPhysicalMaterialInfosInTable

(

const Dtk_PhysicalMaterialInfosPtr &

inNewMaterialInfos

)

AddRenderInfosInTable()

Dtk_ID Dtk_API::AddRenderInfosInTable

(

const Dtk_RenderInfosPtr &

inNewRenderInfos

)

AddSearchPath()

Dtk_ErrorStatus Dtk_API::AddSearchPath	(	const Dtk_SearchFileEnum::RecursivityEnum &	inRecursivityEnum,
		const Dtk_string &	inPath
	)

Add search path to find missing files.

Parameters

[in]	inRecursivityEnum	: value of which search type from Dtk_SearchFileEnum::RecursivityEnum
[in]	inPath	: Path to search file

Returns

dtkNoError if OK

AddSearchPathForAssembly()

Dtk_ErrorStatus Dtk_API::AddSearchPathForAssembly	(	Dtk_string &	inPath,
		Dtk_bool	inRecursiveFlag
	)

Add search path to find missing files of assemblies.

Parameters

[in]	inPath	: Path to search missing files
[out]	inRecursiveFlag	: Search in subdirectories of inPath if DTK_TRUE

Returns

dtkNoError if OK

AddSearchPathForFonts()

Dtk_ErrorStatus Dtk_API::AddSearchPathForFonts

(

const Dtk_string &

inPath

)

Add search path to find fonts.

Parameters

[in]

inPath

: Path to search fonts

Returns

dtkNoError if OK

BreakApi()

void Dtk_API::BreakApi

(

)

ClearSearchPathForAssembly()

Dtk_ErrorStatus Dtk_API::ClearSearchPathForAssembly

(

)

Clear Search Path initialised with AddSearchPathForAssembly.

Returns

dtkNoError if OK

ClearSearchPathForFonts()

Dtk_ErrorStatus Dtk_API::ClearSearchPathForFonts

(

)

Clear Search Path initialised with AddSearchPathForFonts.

Returns

dtkNoError if OK

ClearSearchPriority()

Dtk_ErrorStatus Dtk_API::ClearSearchPriority

(

)

Clear Search Priority.

Returns

dtkNoError if OK

DeactivateFlexlmCall()

static void Dtk_API::DeactivateFlexlmCall ( )

static

Deactivate FlexlmCall.

DeactivateSearchFileEngine()

void Dtk_API::DeactivateSearchFileEngine

(

)

DesactivateDrawingRead()

void Dtk_API::DesactivateDrawingRead

(

)

Desactivate Drawing read.

EndComponent()

Dtk_ErrorStatus Dtk_API::EndComponent

(

Dtk_ComponentPtr &

inComponent

)

EndComponent.

Parameters

[in]

inComponent

: Component to free.

Returns

dtkNoError if OK

EndDocument()

Dtk_ErrorStatus Dtk_API::EndDocument

(

Dtk_MainDocPtr &

inoutDocument

)

Close a Document.

Parameters

[in,out]

inoutDocument

: Assembly Tree opened with OpenDocument or OpenDocumentGraphic.

Returns

Pointer on API

ForceUpdateAssembly()

void Dtk_API::ForceUpdateAssembly

(

)

Force to update the intern assembly definition by extern definition.

GetAPI()

static Dtk_API* Dtk_API::GetAPI ( )

static

Get DATAKIT API.

Returns

Pointer on API

GetBodyModePreference()

dtk_BodyMode Dtk_API::GetBodyModePreference

(

)

GetBuildingMaterialInTable()

Dtk_BuildingMaterialPtr Dtk_API::GetBuildingMaterialInTable

(

Dtk_ID

inId

)

const

GetColorInTable()

Dtk_ErrorStatus Dtk_API::GetColorInTable	(	const Dtk_Int32	inIndex,
		Dtk_RGB &	outColor
	)

GetColor in API Lut form index.

Parameters

[in]	inIndex	: Color Index
[out]	outColor	: RGB Color corresponding to inIndex

Returns

dtkNoError if OK

GetColorTable()

Dtk_ColorTable* Dtk_API::GetColorTable

(

)

GetConfig()

Dtk_Config* Dtk_API::GetConfig

(

)

GetCurveLineTypeDefinitionInTable()

Dtk_LineTypeDefinitionPtr Dtk_API::GetCurveLineTypeDefinitionInTable

(

const Dtk_ID

inId

)

const

GetFilePreview()

Dtk_ErrorStatus Dtk_API::GetFilePreview	(	const Dtk_string &	inInputFile,
		Dtk_PreviewPtr &	outPreview
	)

Independant method to get preview of inInputFile.

Parameters

[in]	inInputFile	: File to read.
[out]	outPreview	: File Preview if found.

Returns

dtkNoError if OK

GetFileReaderType()

DtkReaderType Dtk_API::GetFileReaderType

(

const Dtk_string &

inFileName

)

Independant method to get DtkReaderType associated to inFileName.

Parameters

[in]

inInputFile

: File to read.

Returns

Module type or UnknownModule

GetFileVersion()

Dtk_ErrorStatus Dtk_API::GetFileVersion	(	const Dtk_string &	inInputFile,
		Dtk_string &	outVersion
	)

Independant method to get version of inInputFile.

Parameters

[in]	inInputFile	: File to read.
[out]	outVersion	: File Version if found.

Returns

Error if version not supported

GetInvalidLicenseList()

Dtk_ErrorStatus Dtk_API::GetInvalidLicenseList

(

Dtk_tab< Dtk_string > &

outList

)

Returns List of Failed Licence ever checked.

Parameters

[out]

outList

: List of Product Name

GetLog()

const Dtk_LogPtr& Dtk_API::GetLog

(

)

GetLogFile()

const Dtk_string& Dtk_API::GetLogFile

(

)

const

GetMaterialInTable()

Dtk_RenderInfosPtr Dtk_API::GetMaterialInTable

(

Dtk_ID

inId

)

const

GetNumBuildingMaterialInTable()

Dtk_Size_t Dtk_API::GetNumBuildingMaterialInTable

(

)

const

GetNumColorInTable()

Dtk_Size_t Dtk_API::GetNumColorInTable

(

)

const

Get Number of Colors in API Lut

Returns

Number of Colors

GetNumCurveLineTypeDefinitionsInTable()

Dtk_Size_t Dtk_API::GetNumCurveLineTypeDefinitionsInTable

(

)

const

GetNumMaterialInTable()

Dtk_Size_t Dtk_API::GetNumMaterialInTable

(

)

const

GetNumPhysicalMaterialInfosInTable()

Dtk_Size_t Dtk_API::GetNumPhysicalMaterialInfosInTable

(

)

const

GetNumRenderInfosInTable()

Dtk_Size_t Dtk_API::GetNumRenderInfosInTable

(

)

const

GetPhysicalMaterialInfosInTable()

Dtk_PhysicalMaterialInfosPtr Dtk_API::GetPhysicalMaterialInfosInTable

(

Dtk_ID

inId

)

const

GetRenderInfosInTable()

Dtk_RenderInfosPtr Dtk_API::GetRenderInfosInTable

(

Dtk_ID

inId

)

const

GetSchemaDir()

const Dtk_string& Dtk_API::GetSchemaDir

(

)

const

GetSearchPathForAssembly()

Dtk_ErrorStatus Dtk_API::GetSearchPathForAssembly	(	Dtk_tab< Dtk_string > &	outPathArray,
		Dtk_tab< Dtk_bool > &	outRecursiveFlagArray
	)		const

GetSearchPathForFonts()

Dtk_ErrorStatus Dtk_API::GetSearchPathForFonts

(

Dtk_tab< Dtk_string > &

outPathArray

)

const

GetVersion()

Dtk_string Dtk_API::GetVersion

(

)

const

GetVersion of DatakitLibs.

GetWorkingDir()

const Dtk_string& Dtk_API::GetWorkingDir

(

)

const

IsBroken()

Dtk_bool Dtk_API::IsBroken

(

)

IsDialogBoxActivated()

Dtk_bool Dtk_API::IsDialogBoxActivated

(

)

IsExtraControlEnable()

Dtk_bool Dtk_API::IsExtraControlEnable

(

)

IsNewFdtReadActivated()

Dtk_bool Dtk_API::IsNewFdtReadActivated

(

)

IsReversedRevolutionActivated()

Dtk_bool Dtk_API::IsReversedRevolutionActivated

(

)

IsSearchFileEngineActivated()

Dtk_bool Dtk_API::IsSearchFileEngineActivated

(

)

LoadConfigFile() [1/2]

Dtk_ErrorStatus Dtk_API::LoadConfigFile

(

const Dtk_string &

inConfigFile

)

LoadConfigFile() [2/2]

Dtk_ErrorStatus Dtk_API::LoadConfigFile

(

FILE *

inConfigFile

)

ManageSearchFile()

void Dtk_API::ManageSearchFile

(

Dtk_SearchFileEnum::Status

inStatus

)

OpenDocument()

Dtk_ErrorStatus Dtk_API::OpenDocument	(	const Dtk_string &	inInputFile,
		Dtk_MainDocPtr &	outDocument
	)

Open a Document (call EndDocument to close it)

Parameters

[in]	inInputFile	: File to read.
[out]	outDocument	: Assembly Tree corresponding to inInputFile.

Returns

dtkNoError if OK

OpenDocumentGraphic()

Dtk_ErrorStatus Dtk_API::OpenDocumentGraphic	(	const Dtk_string &	inInputFile,
		Dtk_MainDocPtr &	outDocument
	)

Open a Document for graphical representation(call EndDocument to close it)

Parameters

[in]	inInputFile	: File to read.
[out]	outDocument	: Assembly Tree corresponding to Graphical representation of inInputFile.

Returns

dtkNoError if OK

PopulateComponentsTree()

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

ReadComponent()

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

Read Component from Assembly Tree (Call EndComponent to free data allocated)

Parameters

[in]	inComponent	: Component to read.
[out]	outRootNode	: Root of construction tree read. Can be NULL if component is empty

Returns

dtkNoError if OK

ReadComponentGraphic()

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

Read graphical data from Component (Call EndComponent to free data allocated)

Parameters

[in]	inComponent	: Component to read.
[out]	outGraphicalData	: Dtk_GraphicalData with meshes or drawing

Returns

dtkNoError if OK

ReadConnectedEntity()

Dtk_ErrorStatus Dtk_API::ReadConnectedEntity	(	const Dtk_MainDocPtr &	inDoc,
		const Dtk_NodeConnectorPtr &	inConnector,
		Dtk_tab< Dtk_EntityPtr > &	outEntity
	)

Internal Use.

SetAbovePathSearchFlag()

void Dtk_API::SetAbovePathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Above Search for files of assembly.

SetAdditionnalPathSearchFlag()

void Dtk_API::SetAdditionnalPathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Additionnal Path Search for files of assembly.

SetBelowPathSearchFlag()

void Dtk_API::SetBelowPathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Below Search for files of assembly.

SetBodyModePreference()

void Dtk_API::SetBodyModePreference

(

dtk_BodyMode

inMode

)

Set Body Topology Preference.

SetControlOnExtraModule()

void Dtk_API::SetControlOnExtraModule

(

Dtk_bool

inControl

)

Disable/Enable Control for extra module.

SetInternalReadPathSearchFlag()

void Dtk_API::SetInternalReadPathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Internal Read Path Search for files of assembly.

SetLocalPathSearchFlag()

void Dtk_API::SetLocalPathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Local Path Search for files of assembly.

SetLogFile()

Dtk_ErrorStatus Dtk_API::SetLogFile

(

const Dtk_string &

inLogFile

)

Set Log File.

Parameters

[in]

inLogFile

: File where API can write infos.

Returns

dtkNoError if OK

SetReadCustomAttribut()

void Dtk_API::SetReadCustomAttribut

(

Dtk_bool

bRead

)

read customers attribut

SetRelativePathSearchFlag()

void Dtk_API::SetRelativePathSearchFlag

(

Dtk_bool

inActivationFlag

)

Allow Relative Search for files of assembly.

SetSchemaDir()

Dtk_ErrorStatus Dtk_API::SetSchemaDir

(

const Dtk_string &

inSchemaDir

)

Set Schema Directory needed for Unigraphics, Parasolid, Solidedge, Solidworks and Jt readers.

Parameters

[in]

inSchemaDir

: Directory where API can find Parasolid Schema.

Returns

dtkNoError if OK

SetSearchPositionMode()

Dtk_ErrorStatus Dtk_API::SetSearchPositionMode	(	Dtk_Int32	inPosition,
		Dtk_SearchFileEnum::PriorityModeEnum	inSearchEnum
	)

Set Search Position.

Parameters

[in]	inPosition	: position into search array 0..5
[out]	inSearchEnum	: Search enum

Returns

dtkNoError if OK

SetWorkingDir()

Dtk_ErrorStatus Dtk_API::SetWorkingDir

(

const Dtk_string &

inWorkingDir

)

Change TemporyDirectory.

Parameters

[in]

inWorkingDir

: Directory where API can write temporary files.

Returns

dtkNoError if OK

StartAPI()

static Dtk_API* Dtk_API::StartAPI ( const Dtk_string &  inTemporyDirectory, Dtk_ErrorStatus &  outErrorCode, const Dtk_string &  inCustomerID = Dtk_string()  )

static

Start DATAKIT API.

Parameters

[in]	inTemporyDirectory	: Directory where API can write temporary files.
[out]	outErrorCode	: Error code if API returned is NULL.
[in]	inCustomerID	: Customer ID if you have one.

Returns

Pointer on API if OK, NULL if can't write in inTemporyDirectory or can't find licence

StopAPI()

static void Dtk_API::StopAPI ( Dtk_API *&  inAPI, Dtk_bool  inWriteTimeInLog = 1  )

static

Stop DATAKIT API.

Parameters

[in]

inAPI

: Api to stop.

WriteInDebugFile()

Dtk_ErrorStatus Dtk_API::WriteInDebugFile

(

const Dtk_string &

inString

)

WriteInLogFile() [1/2]

Dtk_ErrorStatus Dtk_API::WriteInLogFile

(

const char *

inString

)

WriteInLogFile() [2/2]

Dtk_ErrorStatus Dtk_API::WriteInLogFile

(

const Dtk_string &

inString

)

Friends And Related Function Documentation

_3dmReader

friend class _3dmReader

friend

AcisReader

friend class AcisReader

friend

ArtReader

friend class ArtReader

friend

BRepOccReader

friend class BRepOccReader

friend

CaddsReader

friend class CaddsReader

friend

CatiaV4Reader

friend class CatiaV4Reader

friend

CatiaV5Reader

friend class CatiaV5Reader

friend

CatiaV6Reader

friend class CatiaV6Reader

friend

CerconReader

friend class CerconReader

friend

CerecReader

friend class CerecReader

friend

CgmReader

friend class CgmReader

friend

CgrReader

friend class CgrReader

friend

CreoviewReader

friend class CreoviewReader

friend

DcmReader

friend class DcmReader

friend

DstvReader

friend class DstvReader

friend

Dtk_APIContext

friend class Dtk_APIContext

friend

Dtk_Component

friend class Dtk_Component

friend

Dtk_MainDocWrapper

friend class Dtk_MainDocWrapper

friend

Dtk_Node

friend class Dtk_Node

friend

DwgDtkReader

friend class DwgDtkReader

friend

DwgReader

friend class DwgReader

friend

DxfReader

friend class DxfReader

friend

F3dReader

friend class F3dReader

friend

FbxReader

friend class FbxReader

friend

GltfReader

friend class GltfReader

friend

IfcReader

friend class IfcReader

friend

IgesReader

friend class IgesReader

friend

InvReader

friend class InvReader

friend

JtReader

friend class JtReader

friend

LavaReader

friend class LavaReader

friend

NavisReader

friend class NavisReader

friend

ObjReader

friend class ObjReader

friend

PlmXmlReader

friend class PlmXmlReader

friend

PrcReader

friend class PrcReader

friend

ProCeraReader

friend class ProCeraReader

friend

ProeReader

friend class ProeReader

friend

PsReader

friend class PsReader

friend

QifReader

friend class QifReader

friend

RevitReader

friend class RevitReader

friend

RnXmlReader

friend class RnXmlReader

friend

SdnfReader

friend class SdnfReader

friend

SeReader

friend class SeReader

friend

SmgReader

friend class SmgReader

friend

SolidEdgeReader

friend class SolidEdgeReader

friend

StepReader

friend class StepReader

friend

StlReader

friend class StlReader

friend

SwReader

friend class SwReader

friend

UgReader

friend class UgReader

friend

VdaReader

friend class VdaReader

friend

XmlReader

friend class XmlReader

friend

XmtReader

friend class XmtReader

friend

Zw3dReader

friend class Zw3dReader

friend

Field Documentation

_3dmReader

Dtk_Reader* Dtk_API::_3dmReader

staticprotected

_AcisReader

Dtk_Reader* Dtk_API::_AcisReader

staticprotected

_ArtReader

Dtk_Reader* Dtk_API::_ArtReader

staticprotected

_BRepOccReader

Dtk_Reader* Dtk_API::_BRepOccReader

staticprotected

_CaddsReader

Dtk_Reader* Dtk_API::_CaddsReader

staticprotected

_CerconReader

Dtk_Reader* Dtk_API::_CerconReader

staticprotected

_CerecReader

Dtk_Reader* Dtk_API::_CerecReader

staticprotected

_CgmReader

Dtk_Reader* Dtk_API::_CgmReader

staticprotected

_CgrReader

Dtk_Reader* Dtk_API::_CgrReader

staticprotected

_CreoviewReader

Dtk_Reader* Dtk_API::_CreoviewReader

staticprotected

_CurrentAPI

Dtk_API* Dtk_API::_CurrentAPI

staticprotected

_DcmReader

Dtk_Reader* Dtk_API::_DcmReader

staticprotected

_DstvReader

Dtk_Reader* Dtk_API::_DstvReader

staticprotected

_DwgDtkReader

Dtk_Reader* Dtk_API::_DwgDtkReader

staticprotected

_DwgReader

Dtk_Reader* Dtk_API::_DwgReader

staticprotected

_DxfReader

Dtk_Reader* Dtk_API::_DxfReader

staticprotected

_F3dReader

Dtk_Reader* Dtk_API::_F3dReader

staticprotected

_FbxReader

Dtk_Reader* Dtk_API::_FbxReader

staticprotected

_GltfReader

Dtk_Reader* Dtk_API::_GltfReader

staticprotected

_IfcReader

Dtk_Reader* Dtk_API::_IfcReader

staticprotected

_IgesReader

Dtk_Reader* Dtk_API::_IgesReader

staticprotected

_InvReader

Dtk_Reader* Dtk_API::_InvReader

staticprotected

_JtReader

Dtk_Reader* Dtk_API::_JtReader

staticprotected

_Lava3mReader

Dtk_Reader* Dtk_API::_Lava3mReader

staticprotected

_NavisReader

Dtk_Reader* Dtk_API::_NavisReader

staticprotected

_ObjReader

Dtk_Reader* Dtk_API::_ObjReader

staticprotected

_PlmXmlReader

Dtk_Reader* Dtk_API::_PlmXmlReader

staticprotected

_PrcReader

Dtk_Reader* Dtk_API::_PrcReader

staticprotected

_Private

Dtk_Handle* Dtk_API::_Private

protected

_ProCeraReader

Dtk_Reader* Dtk_API::_ProCeraReader

staticprotected

_ProeReader

Dtk_Reader* Dtk_API::_ProeReader

staticprotected

_QifReader

Dtk_Reader* Dtk_API::_QifReader

staticprotected

_RevitReader

Dtk_Reader* Dtk_API::_RevitReader

staticprotected

_RnXmlReader

Dtk_Reader* Dtk_API::_RnXmlReader

staticprotected

_SdnfReader

Dtk_Reader* Dtk_API::_SdnfReader

staticprotected

_SeReader

Dtk_Reader* Dtk_API::_SeReader

staticprotected

_SmgReader

Dtk_Reader* Dtk_API::_SmgReader

staticprotected

_StepReader

Dtk_Reader* Dtk_API::_StepReader

staticprotected

_StlReader

Dtk_Reader* Dtk_API::_StlReader

staticprotected

_SwReader

Dtk_Reader* Dtk_API::_SwReader

staticprotected

_UgReader

Dtk_Reader* Dtk_API::_UgReader

staticprotected

_V4Reader

Dtk_Reader* Dtk_API::_V4Reader

staticprotected

_V5Reader

Dtk_Reader* Dtk_API::_V5Reader

staticprotected

_V6Reader

Dtk_Reader* Dtk_API::_V6Reader

staticprotected

_VdaReader

Dtk_Reader* Dtk_API::_VdaReader

staticprotected

_XmlReader

Dtk_Reader* Dtk_API::_XmlReader

staticprotected

_XmtReader

Dtk_Reader* Dtk_API::_XmtReader

staticprotected

_Zw3dReader

Dtk_Reader* Dtk_API::_Zw3dReader

staticprotected