catiav5w::Pmi Namespace Reference

Data Structures
class	CATTPSPmi
	This is the wrapper class handling Generic PMI - virtual class -. More...
class	CATTPSText
	This is the entity handling native Text PMI enity The CATTPText only has got 2 leader anchor points: DTK_ANCHOR_BOTTOM_LEFT and DTK_ANCHOR_BOTTOM_RIGHT. More...
class	DrwLeader
	This is the wrapper class handling V5 write leader data. More...
class	RTFText
	This is the wrapper class handling Catia V5 RTFText. This is the V5 internal text data. More...

Functions
Dtk_ErrorStatus	CreateAnnotationSet (const Dtk_string &inAnnotationSetName, const Dtk_bool inBlankedStatus=DTK_FALSE)
	This function lets you create a PMI AnnotationSet This is the first and the main enity handling PMIs. If the AnnotationSet doesn't exist, you won't be able to create another PMI entity. More...
Dtk_ErrorStatus	CreateCATTPSText (const CATTPSText &inText, const G5w_PmiId inOwningView, G5w_PmiId &outPmiId)
	This function lets you create a PMI native text. A view must be created before adding a PMI. More...
Dtk_ErrorStatus	CreateView (const Dtk_string &inViewSetName, const Dtk_transfo &inTransfo, G5w_PmiId &outPmiId, const Dtk_bool inBlankedStatus=DTK_FALSE)
	This function lets you create a PMI view A view must be created before adding a PMI. More...

Function Documentation

CreateAnnotationSet()

Dtk_ErrorStatus catiav5w::Pmi::CreateAnnotationSet	(	const Dtk_string &	inAnnotationSetName,
		const Dtk_bool	inBlankedStatus = DTK_FALSE
	)

This function lets you create a PMI AnnotationSet This is the first and the main enity handling PMIs. If the AnnotationSet doesn't exist, you won't be able to create another PMI entity.

Parameters

[in]	inAnnotationSetName	The Annotation Set Name
[in]	inBlankedStatus	The Annotation Set Blanked Status - DTK_FALSE for visible and DTK_TRUE for hidden -

Returns

dtkNoError if no problem.

Warning

The PMI are not handled with R14 release.

CreateCATTPSText()

Dtk_ErrorStatus catiav5w::Pmi::CreateCATTPSText	(	const CATTPSText &	inText,
		const G5w_PmiId	inOwningView,
		G5w_PmiId &	outPmiId
	)

This function lets you create a PMI native text. A view must be created before adding a PMI.

Parameters

[in]	inText	The CATTPSText
[in]	inOwningView	The owning View ID.
[out]	outPmiId	The returning PMI ID - for further use -.

Returns

dtkNoError if no problem.

CreateView()

Dtk_ErrorStatus catiav5w::Pmi::CreateView	(	const Dtk_string &	inViewSetName,
		const Dtk_transfo &	inTransfo,
		G5w_PmiId &	outPmiId,
		const Dtk_bool	inBlankedStatus = DTK_FALSE
	)

This function lets you create a PMI view A view must be created before adding a PMI.

Parameters

[in]	inViewSetName	The View Name
[in]	inTransfo	The View transformation matrix.
[out]	outPmiId	The returning View ID - for further use -.
[in]	inBlankedStatus	The View Blanked Status - DTK_FALSE for visible and DTK_TRUE for hidden -

Returns

dtkNoError if no problem.