Export Module

Types

A3DRWParamsExportPrcData

A3DRWParamsExportU3DData

A3DRWParamsExportStepData

A3DRWParamsExportJTData

A3DRWParamsExportIgesData

A3DRWParamsExportStlData

A3DRWParamsExport3mfData

A3DRWParamsExportXMLData

A3DRWParamsExportObjData

A3DRWParamsExportFbxData

A3DRWParamsExportGltfData

A3DRWParamsExportParasolidData

A3DChainedBuffer_t

A3DRWParamsTranslateToPkPartsData

A3DRWParamsExportAcisData

A3DEWriteGeomTessMode

A3DECompressBrepType

A3DEStepFormat

A3DETranslateToPkPartsHealing

A3DETranslateToPkPartsAccurate

A3DETranslateToPkPartsSimplifyGeometry

A3DETranslateToPkPartsMergeEntities

A3DEU3DVersion

A3DEJTVersion

Type Aliases

struct A3DChainedBuffer_t

A3DChainedBuffer

Fields

kA3DWriteGeomOnly

kA3DWriteGeomAndTess

kA3DWriteTessOnly

kA3DCompressionLow

kA3DCompressionMedium

kA3DCompressionHigh

kA3DStepAP203

kA3DStepAP214

kA3DStepAP242

kA3DE_HEALING_NO

kA3DE_HEALING_YES

kA3DE_HEALING_ONLY_IF_NOT_PARASOLID

kA3DE_ACCURATE_NO

kA3DE_ACCURATE_YES

kA3DE_ACCURATE_ONLY_IF_NOT_PARASOLID

kA3DE_SIMPLIFY_NO

kA3DE_SIMPLIFY_YES

kA3DE_SIMPLIFY_ONLY_IF_NOT_PARASOLID

kA3DE_MERGE_NO

kA3DE_MERGE_YES

kA3DE_MERGE_ONLY_IF_NOT_PARASOLID

kA3DECMA1

kA3DECMA3

kA3DE_JT81

kA3DE_JT95

kA3DE_JT100

Functions

A3DStatus

A3DAsmModelFileExportToPrcFile

A3DVoid

A3DRWParamsPrcWriteHelperFree

A3DStatus

A3DAsmModelFileExportToU3DFile

A3DStatus

A3DAsmModelFileExportToStepFile

A3DStatus

A3DAsmModelFileExportToJTFile

A3DStatus

A3DAsmModelFileExportToVrmlFile

A3DStatus

A3DAsmModelFileExportToIgesFile

A3DStatus

A3DAsmModelFileExportToStlFile

A3DStatus

A3DAsmModelFileExportTo3mfFile

A3DStatus

A3DAsmModelFileExportToXMLFile

A3DStatus

A3DAsmModelFileExportToObjFile

A3DStatus

A3DAsmModelFileExportToFbxFile

A3DStatus

A3DAsmModelFileExportToGltfFile

A3DStatus

A3DFileContextDelete

A3DStatus

A3DAsmModelFileLoadFromPRCFiles

A3DStatus

A3DAsmModelFileLoadFromMultiplePrcFile

A3DStatus

A3DAsmModelFileExportToParasolidFile

A3DStatus

A3DChainedBufferFree

A3DStatus

A3DAsmModelFileExportToParasolidBuffer

A3DStatus

A3DRepresentationItemExportToParasolidFile

A3DStatus

A3DRepresentationItemExportToParasolidBuffer

A3DStatus

A3DAsmModelFileTranslateToPkParts

A3DStatus

A3DRepresentationItemTranslateToPkParts

A3DStatus

A3DRepresentationItemsTranslateToPkPartsMultiProcess

A3DStatus

A3DHealPkParts

A3DStatus

A3DMiscPKMapperGetPKEntitiesFromA3DEntity

A3DStatus

A3DMiscPKMapperGetA3DEntitiesFromPKEntity

A3DStatus

A3DAsmModelFileExportToParasolidFileWithMapper

A3DStatus

A3DAsmModelFileExportToParasolidBufferWithMapper

A3DStatus

A3DAsmModelFileExportToPrcStream

A3DStatus

A3DAsmModelFileExportToAcisFile

A3DStatus

A3DAsmModelFileExportToAcisBuffer

A3DStatus

A3DRepresentationItemExportToAcisBuffer

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.

enum A3DEU3DVersion

U3D formats supported for export.

Version

4.0

Values:

enumerator kA3DECMA1

ECMA-363, version 1 writing.

(Acrobat Reader 7.0 compatible).

enumerator kA3DECMA3

ECMA-363, version 3 writing.

enum A3DEJTVersion

JT formats supported for export.

Version

10.0

Values:

enumerator kA3DE_JT81

JT version 8.1 writing.

enumerator kA3DE_JT95

JT version 9.5 writing.

enumerator kA3DE_JT100

JT version 10.0 writing.

Type Alias Documentation

typedef struct A3DChainedBuffer_t A3DChainedBuffer

A structure that contains chained buffers.

It is used to by:

Version

4.0

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

A3DStatus A3DFileContextDelete(A3DFileContextData *pData)

This function is used to free memory allocated by following functions: A3DAsmGetFilesContextsFromModelFile .

Version

8.1

Return values:
  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_DATA_STRUCT_SIZE

  • A3D_INVALID_DATA_STRUCT_NULL

  • A3D_INVALID_ENTITY_NULL

  • A3D_INVALID_ENTITY_TYPE

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DAsmModelFileLoadFromPRCFiles(const A3DUTF8Char *pcRootPrcFilePath, const A3DUns32 uNbFile, const A3DUTF8Char **ppPRCFilePath, const A3DUTF8Char **ppCADFilePath, const A3DRWParamsLoadData *pParamsLoadData, A3DAsmModelFile **pA3DAsmModelFile)

Creates a model file from multiple PRC files + a PRC assembly file + a map for file names.

This function inserts all the parts and product occurrences from a file list into a single PRC assembly file loaded in “assembly NO Dependency” mode and outputs a reassembled model file.

Version

7.1

Parameters:
  • pcRootPrcFilePath[in] The file name of the top assembly file. This model file is loaded as assembly tree only and saved as a PRC file.

  • uNbFile[in] The number of file names to plug into the assembly.

  • ppPRCFilePath[in] The equivalent PRC file paths for parts. Length must equal uNbFile.

  • ppCADFilePath[in] The native part file paths. Length must equal uNbFile.

  • pParamsLoadData[in] The parameters to use when reading the model files. Configuration must be set to read the default entry or must only specify a single entry to read.

  • pA3DAsmModelFile[out] The final reassembled model file.

Return values:
  • A3D_ERROR

  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_DATA

  • A3D_LOAD_INVALID_FILE_NAME

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DAsmModelFileLoadFromMultiplePrcFile(const A3DUTF8Char *pcFileName, const A3DUns32 uNbPart, const A3DUTF8Char **ppCADFilePath, const A3DUTF8Char **ppPRCFilePath, const A3DRWParamsLoadData *pParamsLoadData, A3DAsmModelFile **pA3DAsmModelFile)

Creates a model file from multiple PRC files + an PRC assembly file + a map for file names.

This function replugs all the parts from a list from a PRC file loaded with an “assembly tree only” mode.

Version

5.0

Parameters:
  • pcFileName[in] The file name of the top assembly file. Conceived for model file loaded as assembly tree only and saved as a PRC file.

  • uNbPart[in] The number of file names to plug.

  • ppCADFilePath[in] The native part file paths. Length must equal uNbPart.

  • ppPRCFilePath[in] The equivalent PRC file paths for parts. Length must equal uNbPart.

  • pParamsLoadData[in] The read/write parameters use the model file. Configurations must be set (default or numEntries = 1).

  • pA3DAsmModelFile[out] The final reassembled model file.

Return values:

A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToParasolidFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, const A3DUTF8Char *pcCADFileName)

Writes a model file to a physical file in Parasolid 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 on success, or an error code on failure

A3DStatus A3DChainedBufferFree(A3DChainedBuffer *pBuffer)

This function is used to free memory allocated by following functions: A3DAsmModelFileExportToParasolidBuffer A3DRepresentationItemExportToParasolidBuffer A3DAsmModelFileExportToAcisBuffer A3DRepresentationItemExportToAcisBuffer A3DChainedBufferFree .

Version

4.0

A3DStatus A3DAsmModelFileExportToParasolidBuffer(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, A3DChainedBuffer **pBuffer)

Writes a model file to a buffer in Parasolid format.

This function writes the A3DAsmModelFile entity to a buffer.

Version

4.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pParamsExportData[in] References the parameters for export.

  • pBuffer[out] References the chained buffer to be filled.

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_ERROR

  • A3D_WRITE_CANNOT_LOAD_WRITER

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DRepresentationItemExportToParasolidFile(const A3DRiRepresentationItem *pRepItem, const A3DUTF8Char *pcTempFileName, A3DDouble dUnit)

Writes a representation item to a file in Parasolid format.

This function writes the A3DAsmModelFile entity to a file.

Version

4.0

Parameters:
  • pRepItem[in] References the A3DRiRepresentationItem to be written out.

  • pcTempFileName[inout] References the output file to be written.

  • dUnit[in] References the wanted unit for the RI.

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_ERROR

  • A3D_WRITE_CANNOT_LOAD_WRITER

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DRepresentationItemExportToParasolidBuffer(const A3DRiRepresentationItem *pRepItem, A3DChainedBuffer **pBuffer, double dUnit)

Writes a representation item to a buffer in Parasolid format.

This function writes the A3DRiRepresentationItem entity to a buffer.

Version

4.0

Parameters:
  • pRepItem[in] References the A3DRiRepresentationItem to be written out.

  • pBuffer[in] References the chained buffer to be filled.

  • dUnit[in] References the wanted unit for the RI.

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_ERROR

  • A3D_WRITE_CANNOT_LOAD_WRITER

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DAsmModelFileTranslateToPkParts(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData, int *pNbPkParts, int **pPkParts)

Writes a model file to parts in the current Parasolid session.

This function writes the A3DAsmModelFile entity to parts in the current Parasolid session.

Version

8.1

Version

8.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pParamsExportData[in] References the parameters for export.

  • pParamsTranslateToPkPartsData[in] References the parameters to export in the Parasolid session.

  • pNbPkParts[out] References the number of resulting parts.

  • pPkParts[out] References the array of resulting parts. Memory for the pPkParts array should be allocated and freed in Parasolid.

Return values:
  • `A3D_SUCCESS` – In case of success.

  • `A3D_INITIALIZE_NOT_CALLED` – if the library is not initialized.

  • `A3D_INVALID_DATA_STRUCT_NULL` – if either pParamsExportData or pParamsTranslateToPkPartsData is null

  • `A3D_INVALID_DATA_STRUCT_SIZE` – if either pParamsExportData or pParamsTranslateToPkPartsData is incorrectly initialized

  • `A3D_INVALID_ENTITY_NULL` – if pA3DAsmModelFileis null

  • `A3D_INVALID_ENTITY_TYPE` – if pA3DAsmModelFile references an invalid entity type

  • A3D_PARASOLID_MEMORY_ERROR – if Parasolid is out of memory

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DRepresentationItemTranslateToPkParts(const A3DRiRepresentationItem *pRepItem, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData, double dUnit, int *pNbPkParts, int **pPkParts)

Writes a representation item to parts in the current Parasolid session.

This function writes the A3DRiRepresentationItem entity to parts in the current Parasolid session.

Version

8.1

Version

8.0

Parameters:
  • pRepItem[in] References the A3DRiRepresentationItem to be written out.

  • pParamsTranslateToPkPartsData[in] References the parameters to export in the Parasolid session.

  • dUnit[in] References the wanted unit for the RI.

  • pNbPkParts[out] References the number of resulting parts.

  • pPkParts[out] References the array of resulting parts.

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_ERROR

  • A3D_WRITE_CANNOT_LOAD_WRITER

  • A3D_PARASOLID_MEMORY_ERROR

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DRepresentationItemsTranslateToPkPartsMultiProcess(A3DUns32 uiNbProc, A3DRWParamsTranslateToPkPartsData const *pParamsTranslateToPkPartsData, A3DUns32 uiNbRepItem, A3DRiRepresentationItem const **pRepItem, A3DDouble const *padUnit, int **pNbPkParts, int ***pPkParts)

Writes a representation item to parts in the current Parasolid session in multi-process context.

This function writes the A3DRiRepresentationItem entity to parts in the current Parasolid session.

Version

8.1

Version

9.2

Parameters:
  • uiNbProc[in] References the number of processes on which to run

  • pParamsTranslateToPkPartsData[in] References the parameters to export in the Parasolid session.

  • uiNbRepItem[in] References the number of A3DRiRepresentationItem to be written out.

  • pRepItem[in] References the array of A3DRiRepresentationItem to be written out.

  • padUnit[in] References the array of wanted units for the RI.

  • pNbPkParts[out] References the array of numbers of resulting parts.

  • pPkParts[out] References the array of arrays of resulting parts.

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_ERROR

  • A3D_WRITE_CANNOT_LOAD_WRITER

  • A3D_PARASOLID_MEMORY_ERROR

  • A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DHealPkParts(int *pNbPkParts, int **pPkParts, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData)

Heal parts in the current Parasolid session.

Version

8.1

Version

9.1

Parameters:
  • pNbPkParts[in] References the number of resulting parts.

  • pPkParts[inout] References the array of resulting parts.

  • pParamsTranslateToPkPartsData[in] References the parameters to export in the Parasolid session.

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_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DMiscPKMapperGetPKEntitiesFromA3DEntity(const A3DMiscPKMapper *pMapper, const A3DEntity *pA3DEntity, int *piNbPKEntities, int **ppPKEntities)

Get Parasolid entities from HOOPS Exchange entity.

Version

9.0

Parameters:
  • pMapper[in] Topology entities mapper

  • pA3DEntity[in] The HOOPS Exchange entity

  • piNbPKEntities[out] Number of Parasolid entities in the following array

  • ppPKEntities[out] Array of Parasolid entities. This array is internal to the A3DMiscPKMapper and should not be modified (changing it will compromise the A3DMiscPKMapper). The lifetime of this array is the same as the lifetime of the A3DMiscPKMapper.

Return values:

A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DMiscPKMapperGetA3DEntitiesFromPKEntity(const A3DMiscPKMapper *pMapper, int pPKEntity, int *piNbA3DEntities, A3DEntity ***ppA3DEntities)

Get HOOPS Exchange entities from Parasolid entity.

Version

9.0

Parameters:
  • pMapper[in] Topology entities mapper

  • pPKEntity[in] The Parasolid entity

  • piNbA3DEntities[out] Number of HOOPS Exchange entities in the following array

  • ppA3DEntities[out] Array of HOOPS Exchange entities. This array is internal to the A3DMiscPKMapper and shouldn’t be modified (changing it will compromise the A3DMiscPKMapper). The lifetime of this array is the same as the lifetime of the A3DMiscPKMapper.

Return values:

A3D_SUCCESS

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToParasolidFileWithMapper(const A3DAsmModelFile *pA3DAsmModelFile, A3DMiscPKMapper *pMapper, const A3DRWParamsExportParasolidData *pParamsExportData, const A3DUTF8Char *pcCADFileName)

Writes a model file to a physical file in Parasolid format .

This function writes the A3DAsmModelFile entity to a physical file. This function uses the PK bodies already converted and stored in the pMapper with the A3DAsmModelFile structure in order to export them as a Parasolid file.

Version

10.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pMapper[in] Topology entities mapper

  • 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 on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToParasolidBufferWithMapper(const A3DAsmModelFile *pA3DAsmModelFile, A3DMiscPKMapper *pMapper, const A3DRWParamsExportParasolidData *pParamsExportData, A3DChainedBuffer **pBuffer)

Writes a model file to a buffer in Parasolid format .

This function writes the A3DAsmModelFile entity to a physical file. This function uses the PK bodies already converted and stored in the pMapper with the A3DAsmModelFile structure in order to export them as a Parasolid file.

Version

11.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pMapper[in] Topology entities mapper

  • pParamsExportData[in] References the parameters for export.

  • pBuffer[out] Buffer.

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 on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToPrcStream(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportPrcData *pParamsExportData, A3DUTF8Char **pcStream, A3DUns32 *uLength, A3DRWParamsPrcWriteHelper **ppPrcWriteHelper)

Writes a model file to a stream buffer in a PRC format.

This function writes the A3DAsmModelFile entity to a PRC stream buffer.

Version

4.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pParamsExportData[in] References the parameters for export.

  • pcStream[out] Buffer containing the PRC content.

  • uLength[out] Length of the pcStream.

  • 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 on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToAcisFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportAcisData *pParamsExportData, const A3DUTF8Char *pcCADFileName)

Writes a model file to a physical file in ACIS format.

This function writes the A3DAsmModelFile entity to a physical file.

Version

5.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_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 on success, or an error code on failure

A3DStatus A3DAsmModelFileExportToAcisBuffer(const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportAcisData *pParamsExportData, A3DChainedBuffer **pBuffer)

Writes a model file to a buffer in binary ACIS format.

This function writes the A3DAsmModelFile entity to a buffer.

Version

5.0

Parameters:
  • pA3DAsmModelFile[in] References the A3DAsmModelFile to be written out.

  • pParamsExportData[in] References the parameters for export.

  • pBuffer[out] Buffer.

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 on success, or an error code on failure

A3DStatus A3DRepresentationItemExportToAcisBuffer(const A3DRiRepresentationItem *pRepItem, A3DChainedBuffer **pBuffer, double dScale)

Writes a representation item to a buffer in binary ACIS format.

This function writes the A3DRiRepresentationItem entity to a buffer.

Version

7.2

Parameters:
  • pRepItem[in] References the A3DRiRepresentationItem to be written out.

  • pBuffer[in] Buffer.

  • dScale[in] Scale applied to the representation item.

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 on success, or an error code on failure