Objw Namespace Reference

Exported APIs for Obj (.obj) Write Library. More...

Data Structures
class	WriteOptions
	This class provides several options to tune Obj Writer. It must be provided to Objw::InitWrite method. More...

Functions
DtkErrorStatus	EndWrite ()
	Creation of the output file and free the Obj Writer More...
DtkErrorStatus	InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, WriteOptions &inOptions)
	Initialize the Obj Writer More...
Dtk_ErrorStatus	WriteEntity (const Dtk_EntityPtr &inEntity, Dtk_transfo inMat=Dtk_transfo())
	Write the entity provided in parameter in a node. More...

Detailed Description

Exported APIs for Obj (.obj) Write Library.

Function Documentation

EndWrite()

DtkErrorStatus Objw::EndWrite

(

)

Creation of the output file and free the Obj Writer

Returns

dtkNoError if it is OK.

Remarks

used as the last function used for the writer.

InitWrite()

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

Initialize the Obj 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(...)

WriteEntity()

Dtk_ErrorStatus Objw::WriteEntity	(	const Dtk_EntityPtr &	inEntity,
		Dtk_transfo	inMat = Dtk_transfo()
	)

Write the entity provided in parameter in a node.

Parameters

[in]	inEntity	: The Entity to be written
[in]	inMat	: The matrice that needs to be applied before the writing

Returns

dtkNoError if it is OK.

Remarks

This function is used to write entities (only Dtk_MeshPtr ) .