USD Write Util Functions

Functions
Dtk_ErrorStatus	Dtk_UsdWriter::CloseLastInstance ()
	Closes the last opened instance node Must be called once for every successful OpenInstance() call. More...
void	Dtk_UsdWriter::ConfigWriteAscii (Dtk_bool inValue)
	Reserved for future text support. More...
	Dtk_UsdWriter::Dtk_UsdWriter (const Dtk_string &inOutputFile, Dtk_ErrorStatus &outErr, const WriterOptions &inOptions)
	Constructor: initialises the writer for a USD file. More...
Dtk_ErrorStatus	Dtk_UsdWriter::OpenInstance (const Dtk_string &inInstanceName, Dtk_Int64 inProtoID, Dtk_bool &outIsNewInstance, const Dtk_transfo &inTrans=Dtk_transfo(), const Dtk_RGB &inRgb=Dtk_RGB(), const Dtk_tab< Dtk_MetaDataPtr > &inMetaTab=Dtk_tab< Dtk_MetaDataPtr >())
	Opens a new Xform instance node and pushes it onto the hierarchy stack. More...
Dtk_ErrorStatus	Dtk_UsdWriter::WriteMesh (const Dtk_MeshPtr &inMesh)
	Writes a mesh into the current instance node. More...
	Dtk_UsdWriter::~Dtk_UsdWriter ()
	Destructor: flushes and closes the USD file. More...

Detailed Description

Function Documentation

CloseLastInstance()

Dtk_ErrorStatus Dtk_UsdWriter::CloseLastInstance

(

)

Closes the last opened instance node Must be called once for every successful OpenInstance() call.

Returns

dtkNoError on success

ConfigWriteAscii()

void Dtk_UsdWriter::ConfigWriteAscii

(

Dtk_bool

inValue

)

Reserved for future text support.

Parameters

[in]

inValue

Kept for API compatibility; output is currently always binary in .usd

Dtk_UsdWriter()

Dtk_UsdWriter::Dtk_UsdWriter	(	const Dtk_string &	inOutputFile,
		Dtk_ErrorStatus &	outErr,
		const WriterOptions &	inOptions
	)

Constructor: initialises the writer for a USD file.

Parameters

[in]	inOutputFile	Path of the USD file to write (only .usd is supported)
[in]	inOptions	Optional writer configuration
[out]	outErr	dtkNoError on success

OpenInstance()

Dtk_ErrorStatus Dtk_UsdWriter::OpenInstance	(	const Dtk_string &	inInstanceName,
		Dtk_Int64	inProtoID,
		Dtk_bool &	outIsNewInstance,
		const Dtk_transfo &	inTrans = Dtk_transfo(),
		const Dtk_RGB &	inRgb = Dtk_RGB(),
		const Dtk_tab< Dtk_MetaDataPtr > &	inMetaTab = Dtk_tab< Dtk_MetaDataPtr >()
	)

Opens a new Xform instance node and pushes it onto the hierarchy stack.

Parameters

[in]	inInstanceName	Prim name (invalid characters are replaced with '_')
[in]	inProtoID	Prototype identifier for instancing. Pass -1 to disable instancing for this node
[out]	outIsNewInstance	DTK_TRUE when the prim is created for the first time; DTK_FALSE when a inProtoID was already registered and a reference is emitted instead — in that case WriteMesh() calls inside this node are skipped
[in]	inTrans	Transform matrix to apply on the prim (identity by default)
[in]	inRgb	Display colour of the prim (unused by default)
[in]	inMetaTab	Optional metadata attached to the prim

Returns

dtkNoError on success.

WriteMesh()

Dtk_ErrorStatus Dtk_UsdWriter::WriteMesh

(

const Dtk_MeshPtr &

inMesh

)

Writes a mesh into the current instance node.

Parameters

[in]

inMesh

Mesh to write

Returns

dtkNoError on success

~Dtk_UsdWriter()

Dtk_UsdWriter::~Dtk_UsdWriter

(

)

Destructor: flushes and closes the USD file.