_3dxmlw Namespace Reference

Exported APIs for 3dxml (.3dxml) Write Library. More...

Data Structures
class	WriteOptions
	This class provides several options to tune 3dxml Writer. It must be provided to _3dxmlw::InitWrite method. More...
class	WriteParameters
	This class provides several parameters to tunes 3dxml Writter. It must be provided to addInstance3D method. More...

Functions
void	addInstance3D (Dtk_ID parentId, Dtk_ID ref3dId, const Dtk_transfo &matrix, const Dtk_string &objectName, Dtk_MetaDataPtr &inMetadata, const WriteParameters &inParameters=WriteParameters())
	Create Instance3D node. More...
void	addReference3D (const Dtk_string &inName, Dtk_ID inComponentId, Dtk_tab< Dtk_MetaDataPtr > &inMetadata)
	Create Reference3D node. More...
void	addReferenceRep (const Dtk_tab< Dtk_MeshPtr > &inMesh, const Dtk_string &inName, Dtk_Size_t inComponentId)
	Create ReferenceRep node. More...
DtkErrorStatus	EndWrite ()
	Creation of the output file and free the 3dxmlw Writer More...
DtkErrorStatus	InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, WriteOptions &inOptions)
	Initialize the 3dxmlw Writer More...
Dtk_bool	isAlreadyAddComponent (Dtk_ID inCurrentChildId)
	Don't create a component already viewed. Is instantiate by an instance. More...

Detailed Description

Exported APIs for 3dxml (.3dxml) Write Library.

Function Documentation

addInstance3D()

void _3dxmlw::addInstance3D	(	Dtk_ID	parentId,
		Dtk_ID	ref3dId,
		const Dtk_transfo &	matrix,
		const Dtk_string &	objectName,
		Dtk_MetaDataPtr &	inMetadata,
		const WriteParameters &	inParameters = WriteParameters()
	)

Create Instance3D node.

Parameters

[in]	inParentId	: Parent id
[in]	inChildId	: Child id
[in]	inMatrix	: Instance matrix
[in]	inInstanceName	: Instance Name
[in]	inMetadata	: metadata
[in]	inParameters	: parameters

Returns

Remarks

: add only V_description

addReference3D()

void _3dxmlw::addReference3D	(	const Dtk_string &	inName,
		Dtk_ID	inComponentId,
		Dtk_tab< Dtk_MetaDataPtr > &	inMetadata
	)

Create Reference3D node.

Parameters

[in]	inName	: Node Name
[in]	inComponentId	: Component id
[in]	inMetadata	: metadata

Returns

Remarks

: add only V_description

addReferenceRep()

void _3dxmlw::addReferenceRep	(	const Dtk_tab< Dtk_MeshPtr > &	inMesh,
		const Dtk_string &	inName,
		Dtk_Size_t	inComponentId
	)

Create ReferenceRep node.

Parameters

[in]	inMesh	: Mesh Array
[in]	inName	: Node Name
[in]	inComponentId	: Component id

Returns

Remarks

EndWrite()

DtkErrorStatus _3dxmlw::EndWrite

(

)

Creation of the output file and free the 3dxmlw Writer

Returns

dtkNoError if it is OK.

Remarks

used as the last function used for the writer.

InitWrite()

DtkErrorStatus _3dxmlw::InitWrite	(	const Dtk_string &	inOutputFile,
		const Dtk_string &	inLogFile,
		WriteOptions &	inOptions
	)

Initialize the 3dxmlw Writer

Returns

dtkNoError if it is OK.

Parameters

[in]	inOutputFile	: Output file name
[in]	inLogFile	: Log file
[in]	inOptions	: Options

Remarks

This function is the first call for the writer, it must me called after Dtk_API::StartAPI(...)

isAlreadyAddComponent()

Dtk_bool _3dxmlw::isAlreadyAddComponent

(

Dtk_ID

inCurrentChildId

)

Don't create a component already viewed. Is instantiate by an instance.

Parameters

[in]

inCurrentChildId

: Current child id

Returns

DTK_TRUE if component already exist.

Remarks