catiav5w.hpp File Reference

Go to the source code of this file.

Data Structures
class	catiav5w::FileDescription
	This class provides several informations about a CatiaV5 File. It can be used with catiav5w::InitPart and catiav5w::InitProduct functions to specify file properties. More...
class	catiav5w::Material
	This is the wrapper class handling V5 write material data. More...
class	catiav5w::Material::Analysis
class	catiav5w::Material::Lighting
class	catiav5w::WriteOptions
	This class provides several options to tunes CatiaV5 Writter. It must be provided to catiav5w::InitWrite method. More...

Namespaces
	catiav5w
	Exported APIs for CatiaV5 Write Library.

Typedefs
typedef Dtk_ID	catiav5w::MaterialId
typedef Dtk_tab< Dtk_ID >	catiav5w::PathID

Enumerations
enum	catiav5w::NodeType { catiav5w::NodeTypeUnknown = 0, catiav5w::NodeTypeGeometricSet = 1, catiav5w::NodeTypePartBody = 2, catiav5w::NodeTypeMechanicalTool = 3 }
	Type of Specification Tree Node used into a CATPart file. More...

Functions
Dtk_ErrorStatus	catiav5w::AddBooleanParameter (const Dtk_string &inParameterName, const Dtk_bool &inValue)
	Adds a boolean paramater. More...
Dtk_ErrorStatus	catiav5w::AddDoubleParameter (const Dtk_string &inParameterName, const Dtk_Double64 &inValue)
	Adds a double paramater. More...
Dtk_ErrorStatus	catiav5w::AddInstance (const Dtk_ID &inDocId, const Dtk_string &inInstanceName, const Dtk_transfo &inTransfo, Dtk_ID &outInstanceId)
	Add an instance to a DocID into the Current (Sub/Root) CATProduct. More...
Dtk_ErrorStatus	catiav5w::AddIntegerParameter (const Dtk_string &inParameterName, const Dtk_Int32 &inValue)
	Adds a integer paramater. More...
Dtk_ErrorStatus	catiav5w::AddMaterial (const Material &inMaterial, MaterialId &outMaterialId)
	Add a Material in a CATPart context. More...
Dtk_ErrorStatus	catiav5w::AddStringParameter (const Dtk_string &inParameterName, const Dtk_string &inValue)
	Adds a string paramater. More...
Dtk_ErrorStatus	catiav5w::AddVirtualComponentInstance (const Dtk_ID &inDocId, const Dtk_string &inInstanceName, const Dtk_transfo &inTransfo, Dtk_ID &outInstanceId)
	Add an instance to a DocID into the Current (Sub/Root) CATProduct. More...
Dtk_ErrorStatus	catiav5w::CloseCurrentNode ()
	close the current node previously created by catiav5w::CreateNode. More...
Dtk_ErrorStatus	catiav5w::CreateCGRDocId (const Dtk_string &inCGRFileName, const Dtk_string &inCGRName, Dtk_ID &outDocId)
	Create a CGR Reference and DocID related to a given CGR File. More...
Dtk_ErrorStatus	catiav5w::CreateNode (const NodeType &inNodeType, const Dtk_InfoPtr &inInfos)
	Create a node in the Specification Tree. More...
Dtk_ErrorStatus	catiav5w::CreateNode (const NodeType &inNodeType, const Dtk_string &inNodeName=Dtk_string())
	Create a node in the Specification Tree. More...
Dtk_ErrorStatus	catiav5w::CreatePartDocId (const Dtk_string &inPartFileName, const Dtk_string &inPartName, Dtk_ID &outDocId)
	Create a Part Reference and DocID related to a given CATPart. More...
Dtk_ErrorStatus	catiav5w::CreateProductDocId (const Dtk_string &inPartFileName, const Dtk_string &inPartName, Dtk_ID &outDocId)
	Create a Product Reference and DocID related to a given CATProduct. More...
Dtk_ErrorStatus	catiav5w::CreateV4ModelDocId (const Dtk_string &inV4ModelFileName, const Dtk_string &inV4ModelName, Dtk_ID &outDocId)
	Create a V4 Model Reference and DocID related to a given V4 Model File. More...
Dtk_ErrorStatus	catiav5w::EndPart ()
	Free data allocated by catiav5w::InitPart More...
Dtk_ErrorStatus	catiav5w::EndProduct (Dtk_ID &outDocId)
	Write effectively the Sub Product initialized by catiav5w::InitProduct. More...
Dtk_ErrorStatus	catiav5w::EndVirtualComponent (Dtk_ID &outDocId)
	End - and write - the virtual component initialized by catiav5w::InitVirtualComponent. More...
Dtk_ErrorStatus	catiav5w::EndWrite ()
	Free the Catia V5 Writer More...
Dtk_bool	catiav5w::GetWriteHybridBodies ()
Dtk_ErrorStatus	catiav5w::InitPart (const Dtk_string &inOutputFile, const Dtk_string &inReferenceName, Dtk_UUID &outPartUUID, const catiav5w::FileDescription &inFileDescription=catiav5w::FileDescription())
	Initialize the part More...
Dtk_ErrorStatus	catiav5w::InitProduct (const Dtk_string &inFileName, const Dtk_string &inReferenceName, const catiav5w::FileDescription &inFileDescription=catiav5w::FileDescription())
	Initialize a sub Product during CATProduct process. More...
Dtk_ErrorStatus	catiav5w::InitVirtualComponent (const Dtk_string &inReferenceName, const catiav5w::FileDescription &inFileDescription=catiav5w::FileDescription())
	Initialize a virtual component during CATProduct process. More...
Dtk_ErrorStatus	catiav5w::InitWrite (const Dtk_string &inLogFile, Licence_dtk inLicFct, const WriteOptions &inOptions=WriteOptions())
	Initialize the Catia V5 Writer More...
Dtk_bool	catiav5w::IsWriteInitialized ()
	Tells if the Write Module has been initialized or not. More...
Dtk_ErrorStatus	catiav5w::OverrideBlankedStatusWithPathID (const PathID &inInstancePathId, const Dtk_bool inBlankedStatus)
	Override the Blanked Status of an instance in a Sub Product. More...
Dtk_ErrorStatus	catiav5w::OverrideInstanceAlphaWithPathID (const PathID &inInstancePathId, const Dtk_UChar8 inInstanceAlpha)
	Override the Alpha of an instance in a Sub Product. More...
Dtk_ErrorStatus	catiav5w::OverrideInstanceColorWithPathID (const PathID &inInstancePathId, const Dtk_RGB &inInstanceColor)
	Override the Color of an instance in a Sub Product. More...
	catiav5w::SetAsDeprecated ("2023.4", "Use catiav5w::AddInstance( const Dtk_ID&, const Dtk_string&, const Dtk_transfo&, Dtk_ID& ) method instead.") Dtk_ErrorStatus AddInstance(const Dtk_ID &inDocId
	Add an instance to a DocID into the Current (Sub/Root) CATProduct. More...
	catiav5w::SetAsDeprecated ("2023.4", "Use catiav5w::AddVirtualComponentInstance( const Dtk_ID&, const Dtk_string&, const Dtk_transfo&, Dtk_ID& ) method instead.") Dtk_ErrorStatus AddVirtualComponentInstance(const Dtk_ID &inDocId
	Add an instance to a DocID into the Current (Sub/Root) CATProduct. More...
	catiav5w::SetAsDeprecated ("2024.2", "Use Dtk_ErrorStatus catiav5w::AddMaterial( const Material&, MaterialId& ) method instead.") MaterialId AddMaterial(const Material &inMaterial)
	Add a Material in a CATPart context. More...
	catiav5w::SetAsDeprecated ("2024.2", "Use Dtk_ErrorStatus catiav5w::InitPart( const Dtk_string&, const Dtk_string&, Dtk_UUID&, const catiav5w::FileDescription& ) method instead.") Dtk_UUID InitPart(const Dtk_string &inOutputFile
	Initialize the part More...
Dtk_ErrorStatus	catiav5w::SetLayerData (const Dtk_LayerInfosSetPtr &inLayerDataSet)
	Set Layer and LayerFilter Data in a CATPart context. More...
void	catiav5w::SetWriteReferencePlanesAsHidden (const Dtk_bool &inVal)
Dtk_ErrorStatus	catiav5w::WriteEntity (const Dtk_EntityPtr &inEntity)
	Write the entity provided in parameter. More...
Dtk_ErrorStatus	catiav5w::WriteNamedView (const Dtk_ModelDisplayPtr &inNamedView)
	Write the given ModelDisplay as NamedView - V5 camera -. More...

Variables
const Dtk_string const Dtk_transfo const Dtk_bool	catiav5w::inBlankedStatus = 0
const Dtk_string const catiav5w::FileDescription &	catiav5w::inFileDescription = catiav5w::FileDescription() )
const Dtk_string const Dtk_transfo const Dtk_bool const Dtk_RGB &	catiav5w::inInstanceColorAlpha = Dtk_RGB() )
const Dtk_string &	catiav5w::inInstanceName
const Dtk_string &	catiav5w::inReferenceName
const Dtk_string const Dtk_transfo &	catiav5w::inTransfo