Colladaw Namespace Reference

Exported APIs for Collada (.dae) Write Library. More...

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

Functions
DtkErrorStatus	EndNode ()
	End the node. More...
DtkErrorStatus	EndWrite ()
	Creation of the output file and free the Collada Writer More...
DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, Dtk_InfoPtr &inInfo, Dtk_ID &outID)
	Initialize a node. More...
DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo=Dtk_transfo())
	Initialize a node. More...
DtkErrorStatus	InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, WriteOptions &inOptions)
	Initialize the Collada Writer More...
DtkErrorStatus	ReinstanciatePrototype (Dtk_ID inID)
	Reinstanciate a node. More...
Dtk_ErrorStatus	WriteEntity (const Dtk_EntityPtr &inEntity)
	Write the entity provided in parameter in a node. More...
Dtk_ErrorStatus	WriteEntity (const Dtk_EntityPtr &inEntity, Dtk_ID &outID)
	Write the entity provided in parameter in a node. More...

Detailed Description

Exported APIs for Collada (.dae) Write Library.

Function Documentation

EndNode()

DtkErrorStatus Colladaw::EndNode

(

)

End the node.

Returns

dtkNoError if it is OK.

EndWrite()

DtkErrorStatus Colladaw::EndWrite

(

)

Creation of the output file and free the Collada Writer

Returns

dtkNoError if it is OK.

Remarks

used as the last function used for the writer.

InitNode() [1/2]

DtkErrorStatus Colladaw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo,
		Dtk_InfoPtr &	inInfo,
		Dtk_ID &	outID
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node
[in]	inInfo	: The infos (attributes) of the node
[out]	outID	: The identifier of the node

Returns

dtkNoError if it is OK.

Remarks

The node is set as current node children .

To close the node you will need to call EndNode() function .

InitNode() [2/2]

DtkErrorStatus Colladaw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo = Dtk_transfo()
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node

Returns

dtkNoError if it is OK.

Remarks

The node is set as current node children .

To close the node you will need to call EndNode() function .

InitWrite()

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

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

ReinstanciatePrototype()

DtkErrorStatus Colladaw::ReinstanciatePrototype

(

Dtk_ID

inID

)

Reinstanciate a node.

Parameters

[in]

inID

: A unique identifier of the node to be reinstanciated

Returns

dtkNoError if it is OK.

WriteEntity() [1/2]

Dtk_ErrorStatus Colladaw::WriteEntity

(

const Dtk_EntityPtr &

inEntity

)

Write the entity provided in parameter in a node.

Parameters

[in]

inEntity

: The Entity to be written

Returns

dtkNoError if it is OK.

Remarks

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

The entity is stored in current node .

WriteEntity() [2/2]

Dtk_ErrorStatus Colladaw::WriteEntity	(	const Dtk_EntityPtr &	inEntity,
		Dtk_ID &	outID
	)

Write the entity provided in parameter in a node.

Parameters

[in]	inEntity	: The Entity to be written
[out]	outID	: The ID of the written entity

Returns

dtkNoError if it is OK.

Remarks

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

The entity is stored in current node .