Export Module
Types
Fields
Functions
Detailed Description
- group a3d_write
Structures to write the ModelFile defined through this API.
Type Documentation
-
enum A3DEWriteGeomTessMode
WritingMode of the model file. Set which kind of content should be written.
- Version
6.0
Values:
-
enumerator kA3DWriteGeomOnly
Write only geometry.
-
enumerator kA3DWriteGeomAndTess
Mixed mode: write geometry and tessellation.
-
enumerator kA3DWriteTessOnly
Write only tessellation.
-
enum A3DECompressBrepType
Level of compression used to write the model file to PRC format.
This sets the amount, in millimeters, of lossy compression that is applied to geometry. For best results when exporting geometry, use kA3DCompressionLow.
- Version
3.0
Values:
-
enumerator kA3DCompressionLow
Compression with tolerance set to 0.001 mm (low compression, high accuracy).
-
enumerator kA3DCompressionMedium
Compression with tolerance set to 0.01 mm (medium compression, medium accuracy).
-
enumerator kA3DCompressionHigh
Compression with tolerance set to 0.1 mm (high compression, low accuracy).
-
enum A3DEStepFormat
STEP formats supported for export.
- Version
3.0
Values:
-
enumerator kA3DStepAP203
AP 203 Ed 2 since
- Version
9.1
-
enumerator kA3DStepAP214
AP 214.
-
enumerator kA3DStepAP242
AP 242.
- Version
9.1
-
enum A3DETranslateToPkPartsHealing
Control mode of the healing in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
8.1
Values:
-
enumerator kA3DE_HEALING_NO
Disable healing.
-
enumerator kA3DE_HEALING_YES
Enable healing.
-
enumerator kA3DE_HEALING_ONLY_IF_NOT_PARASOLID
Enable healing only for data coming from neither Parasolid nor from any format that embeds Parasolid data (NX, SolidWorks, Solid Edge and JT) but only if the A3DRWParamsParasolidData::m_bKeepParsedEntities reading option is enabled.
-
enum A3DETranslateToPkPartsAccurate
Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
8.1
Values:
-
enumerator kA3DE_ACCURATE_NO
Disable accurate edge computation.
-
enumerator kA3DE_ACCURATE_YES
Enable accurate edge computation.
-
enumerator kA3DE_ACCURATE_ONLY_IF_NOT_PARASOLID
Enable accurate edge computation only for data coming from neither Parasolid nor from any format that embeds Parasolid data (NX, SolidWorks, Solid Edge and JT) but only if the A3DRWParamsParasolidData::m_bKeepParsedEntities reading option is enabled.
-
enum A3DETranslateToPkPartsSimplifyGeometry
Control mode of the simplify in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. It enables the conversion from nurbs to analytical.
- Version
8.1
Values:
-
enumerator kA3DE_SIMPLIFY_NO
Disable simplify.
-
enumerator kA3DE_SIMPLIFY_YES
Enable simplify.
-
enumerator kA3DE_SIMPLIFY_ONLY_IF_NOT_PARASOLID
Enable simplify only for data coming from neither Parasolid nor from any format that embeds Parasolid data (NX, SolidWorks, Solid Edge and JT) but only if the A3DRWParamsParasolidData::m_bKeepParsedEntities reading option is enabled.
-
enum A3DETranslateToPkPartsMergeEntities
Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
8.1
Values:
-
enumerator kA3DE_MERGE_NO
Disable accurate edge computation.
-
enumerator kA3DE_MERGE_YES
Enable accurate edge computation.
-
enumerator kA3DE_MERGE_ONLY_IF_NOT_PARASOLID
Enable accurate edge computation only for data coming from neither Parasolid nor from any format that embeds Parasolid data (NX, SolidWorks, Solid Edge and JT) but only if the A3DRWParamsParasolidData::m_bKeepParsedEntities reading option is enabled.
Function Documentation
-
A3DStatus A3DAsmModelFileExportToPrcFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportPrcData *pParamsExportData, const A3DUTF8Char *pcCADFileName, A3DRWParamsPrcWriteHelper **ppPrcWriteHelper)
Writes a model file to a physical file in a PRC format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
3.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
ppPrcWriteHelper – [inout] Used to get PRC data such as unique identifiers of PRC nodes.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DVoid A3DRWParamsPrcWriteHelperFree(A3DRWParamsPrcWriteHelper *pA3DRWParamsPrcWriteHelper)
Free PRC write helper.
Remark
Because this function does not return A3DStatus the internal thread safety policy is to wait for the availability of the API.
- Version
3.0
- Parameters:
pA3DRWParamsPrcWriteHelper – [inout] The helper to free.
-
A3DStatus A3DAsmModelFileExportToU3DFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportU3DData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in Universal 3D format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
4.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToStepFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStepData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in STEP format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
3.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToJTFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportJTData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in JT format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
6.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToVrmlFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in VRML format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
6.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INVALID_LICENSE –
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToIgesFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportIgesData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in IGES format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
3.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToStlFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStlData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in STL format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
3.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportTo3mfFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExport3mfData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in 3MF format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
10.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToXMLFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportXMLData *pParamsExportData, const A3DUTF8Char *pcXMLFileName, unsigned int *uMapSize, unsigned int **puMapXmlIds, A3DEntity ***ppMapProductOccurrences)
Writes a model file to a physical file in XML format.
This function writes the A3DAsmModelFile entity to a physical file, and fills two arrays of size uMapSize (puMapXmlId and ppMapProductOccurrences) that will act as a map of the product occurrences and their respective IDs in the XML file.
- Version
7.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcXMLFileName – [in] References the path of the file into which the function stores the model file.
uMapSize – [out] Size of the two following arrays. If set to NULL, the map construction is bypassed.
puMapXmlIds – [out] Array of the product occurrence IDs in the XML file. If set to NULL, the map construction is bypassed. It has to be freed with the custom free memory callback.
ppMapProductOccurrences – [out] Array of the product occurrences in the XML file. If set to NULL, the map construction is bypassed. It has to be freed with the custom free memory callback.
- Return values:
A3D_INVALID_LICENSE –
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToObjFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportObjData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in OBJ format (with MTL for the materials).
This function writes the A3DAsmModelFile entity to a physical file.
- Version
12.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToFbxFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportFbxData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in FBX format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
12.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToGltfFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportGltfData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
Writes a model file to a physical file in GLTF/GLB format.
This function writes the A3DAsmModelFile entity to a physical file.
- Version
12.0
- Parameters:
pA3DAsmModelFile – [in] References the A3DAsmModelFile to be written out.
pParamsExportData – [in] References the parameters for export.
pcCADFileName – [in] References the path of the file into which the function stores the model file.
- Return values:
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_WRITE_INVALID_FILE_NAME –
A3D_WRITE_ERROR –
A3D_WRITE_CANNOT_LOAD_WRITER –
A3D_SUCCESS –
- Returns:
A3D_SUCCESS in case of success or an error code
