Structures to write the ModelFile defined through this API. More...
Data Structures | |
struct | A3DRWParamsExport3mfData |
A structure that specifies parameters used to write the model file to 3MF format. More... | |
struct | A3DRWParamsExportFbxData |
A structure that specifies parameters used to write the model file to FBX format. More... | |
struct | A3DRWParamsExportGltfData |
A structure that specifies parameters used to write the model file to GLTF/GLB format. More... | |
struct | A3DRWParamsExportIgesData |
A structure that specifies parameters used to write the model file to IGES format. More... | |
struct | A3DRWParamsExportJTData |
A structure that specifies parameters used to write the model file to JT format. More... | |
struct | A3DRWParamsExportObjData |
A structure that specifies parameters used to write the model file to OBJ format. More... | |
struct | A3DRWParamsExportPrcData |
A structure that specifies parameters used to write the model file to PRC format. More... | |
struct | A3DRWParamsExportStepData |
A structure that specifies parameters used to write the model file to a STEP format. More... | |
struct | A3DRWParamsExportStlData |
A structure that specifies parameters used to write the model file to STL format. More... | |
struct | A3DRWParamsExportU3DData |
A structure that specifies parameters used to write the model file to U3D format. More... | |
struct | A3DRWParamsExportXMLData |
A structure that specifies parameters used to write the model file to XML format. More... | |
Functions | |
A3DStatus | A3DAsmModelFileExportTo3mfFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExport3mfData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in 3MF format. More... | |
A3DStatus | A3DAsmModelFileExportToFbxFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportFbxData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in FBX format. More... | |
A3DStatus | A3DAsmModelFileExportToGltfFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportGltfData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in GLTF/GLB format. More... | |
A3DStatus | A3DAsmModelFileExportToIgesFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportIgesData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in IGES format. More... | |
A3DStatus | A3DAsmModelFileExportToJTFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportJTData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in JT format. More... | |
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). More... | |
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. More... | |
A3DStatus | A3DAsmModelFileExportToStepFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStepData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in STEP format. More... | |
A3DStatus | A3DAsmModelFileExportToStlFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStlData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in STL format. More... | |
A3DStatus | A3DAsmModelFileExportToU3DFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportU3DData *pParamsExportData, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in Universal 3D format. More... | |
A3DStatus | A3DAsmModelFileExportToVrmlFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DUTF8Char *pcCADFileName) |
Writes a model file to a physical file in VRML format. More... | |
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. More... | |
A3DVoid | A3DRWParamsPrcWriteHelperFree (A3DRWParamsPrcWriteHelper *pA3DRWParamsPrcWriteHelper) |
Free PRC write helper. More... | |
Detailed Description
Structures to write the ModelFile defined through this API.
Enumeration Type Documentation
◆ A3DEWriteGeomTessMode
◆ A3DECompressBrepType
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
◆ A3DEStepFormat
enum A3DEStepFormat |
◆ A3DETranslateToPkPartsHealing
Control mode of the healing in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
- 8.1
Enumerator | |
---|---|
kA3DE_HEALING_NO | Disable healing. |
kA3DE_HEALING_YES | Enable healing. |
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. |
◆ A3DETranslateToPkPartsAccurate
Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
- 8.1
Enumerator | |
---|---|
kA3DE_ACCURATE_NO | Disable accurate edge computation. |
kA3DE_ACCURATE_YES | Enable accurate edge computation. |
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. |
◆ A3DETranslateToPkPartsSimplifyGeometry
Control mode of the simplify in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. It enables the conversion from nurbs to analytical.
- Version
- 8.1
Enumerator | |
---|---|
kA3DE_SIMPLIFY_NO | Disable simplify. |
kA3DE_SIMPLIFY_YES | Enable simplify. |
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. |
◆ A3DETranslateToPkPartsMergeEntities
Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData.
- Version
- 8.1
Enumerator | |
---|---|
kA3DE_MERGE_NO | Disable accurate edge computation. |
kA3DE_MERGE_YES | Enable accurate edge computation. |
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. |
◆ A3DEU3DVersion
enum A3DEU3DVersion |
◆ A3DEJTVersion
enum A3DEJTVersion |
Function Documentation
◆ A3DAsmModelFileExportToPrcFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file. [in,out] ppPrcWriteHelper Used to get PRC data such as unique identifiers of PRC nodes.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 3.0
◆ A3DRWParamsPrcWriteHelperFree()
A3DVoid A3DRWParamsPrcWriteHelperFree | ( | A3DRWParamsPrcWriteHelper * | pA3DRWParamsPrcWriteHelper | ) |
Free PRC write helper.
- Parameters
-
[in,out] pA3DRWParamsPrcWriteHelper The helper to free.
- Remarks
- Because this function does not return A3DStatus the internal thread safety policy is to wait for the availability of the API.
- Version
- 3.0
◆ A3DAsmModelFileExportToU3DFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 4.0
◆ A3DAsmModelFileExportToStepFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 3.0
◆ A3DAsmModelFileExportToJTFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS
- Version
- 6.0
◆ A3DAsmModelFileExportToVrmlFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 6.0
◆ A3DAsmModelFileExportToIgesFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 3.0
◆ A3DAsmModelFileExportToStlFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 3.0
◆ A3DAsmModelFileExportTo3mfFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 10.0
◆ A3DAsmModelFileExportToXMLFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcXMLFileName References the path of the file into which the function stores the model file. [out] uMapSize Size of the two following arrays. If set to NULL, the map construction is bypassed. [out] puMapXmlIds 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. [out] ppMapProductOccurrences 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.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 7.0
◆ A3DAsmModelFileExportToObjFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 12.0
◆ A3DAsmModelFileExportToFbxFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 12.0
◆ A3DAsmModelFileExportToGltfFile()
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.
- Parameters
-
[in] pA3DAsmModelFile References the A3DAsmModelFile to be written out. [in] pParamsExportData References the parameters for export. [in] pcCADFileName References the path of the file into which the function stores the model file.
- Returns
- A3D_SUCCESS in case of success or an error code
- 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
- Version
- 12.0