A3DPDFReadWrite.h

Header file for the read-write module.

Author: Tech Soft 3D
Version: 23.0
Date: January 2023
Copyright (c) 2010 - 2023 by Tech Soft 3D, Inc. All rights reserved.

Content

Data Structures

`A3DRWParamsExportScsData`	A structure that specifies parameters used to write a model file to SCS format.
`A3DRWHtmlOfflineData`	Describes an HTML export in offiline mode.
`A3DRwHtmlMetaTag`	Describes an html ‘meta’ element.
`A3DRWParamsExportHtmlData`	A structure that specifies parameters used to write a model file to HTML format.

Type definitions

`A3DPrcIdMap`
`A3DPrcId`

Functions

`A3DAsmModelFileExportToSCSFile()`	Writes a model file to a physical file in SCS format.
`A3DPrcIdMapCreate()`	Function to create a map linking PrcIds and A3DEntities.
`A3DPrcIdMapFindEntity()`	Function to get an A3DEntity from its corresponding PrcId.
`A3DPrcIdMapFindId()`	Function to get the PrcId of a node from an A3DEntity and its father.
`A3DAsmModelFileExportToHTMLFile()`	Writes a model file to a physical file in HTML format.
`A3DPDFDocumentExportToWebFormat()`	Function to export the PDF document into a web format.
`A3DConvertPDFToWebFormat()`	Function that export a pdf into a web format.

Type definitions

typedef void A3DPrcIdMap: An entity that establish the relation between PrcIds and A3DEntity instances. Obtained using A3DPrcIdMapCreate

typedef A3DUTF8Char const *A3DPrcId: Abstraction of a PrcId from a C-String

Functions

A3DStatus A3DAsmModelFileExportToSCSFile(A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportScsData *pParamsExportData, const A3DUTF8Char *pcScsFileName)

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

This function writes the A3DAsmModelFile entity to a SCS stream cache file. (see Export SCS Module).

Version: 10.1

Parameters

pA3DAsmModelFile – [in] References The A3DAsmModelFile to be exported
pParamsExportData – [in] References the parameters for export.
pcScsFileName – [in] References the path of the file into which the function stores the model file.

Return values

A3D_INITIALIZE_NOT_CALLED –
A3D_WRITE_CANNOT_LOAD_WRITER – if libprc2sc dll cannot be loaded
A3D_WRITE_HTMLCONVERSION_FAILED – if conversion execution failed
A3D_NOT_AVAILABLE – if called on unsupported platform
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPrcIdMapCreate(A3DAsmModelFile *pA3DAsmModelFile, A3DPrcIdMap **ppPrcIdToEntityMapOut)

Function to create a map linking PrcIds and A3DEntities.

This function uses an A3DAsmModelFile entity to create a map linking PrcIds and instances of A3DEntity.

In case of success, ppPrcIdToEntityMapOut contains heap allocated memory your are responsible for. To free the memory on ppPrcIdToEntityMapOut, call A3DPrcIdMapCreate with pA3DAsmModelFile set to 0.

Memory Management

Version: 13.0

Parameters

pA3DAsmModelFile – [in] the modelFile used to create map.
ppPrcIdToEntityMapOut – [out] the map of prc ids to A3DEntity pointer.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPrcIdMapFindEntity(A3DPrcIdMap const *pEntityMap, A3DPrcId pcSearchedId, A3DEntity **ppSearchedEntityOut, A3DEntity **ppSearchedEntityFatherOut)

Function to get an A3DEntity from its corresponding PrcId.

Version
Version: 13.0

Parameters

pEntityMap – [in] Pointer on the entity map generated by the function A3DPrcIdMapCreate
pcSearchedId – [in] the Exchange Id of the entity to find
ppSearchedEntityOut – [out] a pointer containing a pointer on the A3DEntity searched or null if not found
ppSearchedEntityFatherOut – [out] a pointer containing a pointer on the Product Occurrence Father of the searched entity or null if not found

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPrcIdMapFindId(A3DPrcIdMap const *pEntityMap, A3DEntity const *searchedEntity, A3DEntity const *searchedEntityFather, A3DPrcId *a_prcIdOut)

Function to get the PrcId of a node from an A3DEntity and its father.

Version: 13.0

Parameters

pEntityMap – [in] Pointer on the entity map generated by the function A3DPrcIdMapCreate
searchedEntity – [in] Pointer to the A3DEntity.
searchedEntityFather – [in] Pointer to the parent A3DEntity of searchedEntity.
a_prcIdOut – [out] PrcId found for the A3DEntity given. This pointer is only available while the A3DPrcIdMap is alive.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DAsmModelFileExportToHTMLFile(A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportHtmlData *pParamsExportData, const A3DUTF8Char *pcHtmlFileName)

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

This function writes the A3DAsmModelFile entity to an HTML file.

Version: 10.1

Parameters

pA3DAsmModelFile – [in] References The A3DAsmModelFile to be exported
pParamsExportData – [in] References the parameters for export.
pcHtmlFileName – [in] References the path of the file into which the function stores the model file.

Return values

A3D_INITIALIZE_NOT_CALLED –
A3D_WRITE_CANNOT_LOAD_WRITER – if libprc2sc dll cannot be loaded
A3D_WRITE_HTMLCONVERSION_FAILED – if conversion execution failed
A3D_NOT_AVAILABLE – if called on unsupported platform
A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPDFDocumentExportToWebFormat(A3DPDFDocument *pDoc, const A3DRWParamsExportHtmlData *pParamsExportData, const A3DUTF8Char *pcOutRootDirectory, const A3DUTF8Char *pcOutputName)

Function to export the PDF document into a web format.

Version: 12.0

Parameters

pDoc – [in] The Document object to export.
pParamsExportData – [in] Export parameters used by each 3D annotation conversion.
pcOutRootDirectory – [in] the root directory to save all created files
pcOutputName – [in] the output file name without extension. It will be an XML root file describing the PDF document in case of an online export. It will be an HTML file in case of an offline export. See A3DWebEHtmlOutputMode.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DConvertPDFToWebFormat(const A3DUTF8Char *pcFileName, const A3DRWParamsExportHtmlData *pParamsExportData, const A3DUTF8Char *pcOutRootDirectory, const A3DUTF8Char *pcOutputName)

Function that export a pdf into a web format.

Version: 12.0

Parameters

pcFileName – [in] The pdf path and name to export
pParamsExportData – [in] Export parameters used by each 3D annotation conversion
pcOutRootDirectory – [in] the root directory to save all created files
pcOutputName – [in] the output file name without extension. It will be an XML root file describing the PDF document in case of an online export. It will be an HTML file in case of an offline export. See A3DWebEHtmlOutputMode.

Return values

A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code