A3DInternalPDFPublishForPDFLayout.h File Reference

Header file for the Publish module and additional functions for PDFLayout product. More...

Functions

A3DStatus A3DPDF3DAnnotGenerateJavascriptHelper (void *ppdAnnot, A3DUTF8Char *pcHelperId, A3DUTF8Char **ppcGeneratedJavascript)
 Function to generate helper section according to the choosen ID. More...
 
A3DStatus A3DPDFFreeModelFileAttributesInfo (A3DPDFModelFileAttributesData **ppModelFileAttributesInfo)
 Function to free the memory allocated for the information of the 3D model attributes. More...
 
A3DStatus A3DPDFGenerateJavascriptDocumentHandler (A3DUTF8Char **ppcGeneratedJavascript)
 Function to generate document handler javascript functions. More...
 
A3DStatus A3DPDFGetModelFileAttributesInfo (A3DAsmModelFile *pModelFile, A3DRWParamsPrcWriteHelper *pPrcWriteHelper, A3DPDFModelFileAttributesData **ppModelFileAttributesInfo)
 Function to get attributes from a modelfile. The function returns an array of elements in the BOM. Each element is the set of components in the assembly associated to the part. More...
 
A3DStatus A3DPDFGetTypeOfAnnotation (void *ppdAnnot, int *pType)
 Function to free the memory allocated for the information of the 3D model attributes. More...
 
A3DStatus A3DPDFPageRemoveTable (A3DPDFPage *pPage, A3DPDFTable *pTable)
 Function to remove a table from a page. More...
 
A3DStatus A3DPDFUpdateDocumentDataWithViews (A3DPDFDocument *pPdfDoc, A3DPDFPage *pPdfPage, A3DPDF3DAnnot *pPdf3DAnnot, void *pPdAnnot3D, A3DAsmModelFile *pModelFile, A3DRWParamsPrcWriteHelper *pA3DRWParamsPrcWriteHelper, const A3DUTF8Char *pcIn3dAttribsFile, A3DPDFCarouselViewData *views, int viewCount, const A3DUTF8Char *pcApplicationVersion)
 Function used by Enrich to replace 3D. More...
 
A3DStatus A3DPDFUpdateDocumentFromXml (A3DPDFDocument *pPdfDoc, XmlManager *xmlManager, int annot3DNumber, A3DUTF8Char **pcAnnot3DUid, A3DPDFModelFileAttributesData **attributesLst)
 Function used by Enrich merge PDF. More...
 
A3DStatus A3DPDFUpdateTextFieldsData (void *pdDoc, const A3DUTF8Char *pcInTextFieldDataFile)
 Function used by Enrich to fill text fields. More...
 

Detailed Description

Header file for the Publish module and additional functions for PDFLayout product.

Author
Tech Soft 3D
Version
9.1
Date
March 2016
Copyright (c) 2016 by Tech Soft 3D, LLC. All rights reserved.

Function Documentation

A3DStatus A3DPDF3DAnnotGenerateJavascriptHelper ( void *  ppdAnnot,
A3DUTF8Char pcHelperId,
A3DUTF8Char **  ppcGeneratedJavascript 
)

Function to generate helper section according to the choosen ID.

Parameters
[in]ppdAnnotThe annotation
[in]pcHelperIdID the the section
[out]ppcGeneratedJavascriptgenerated javascript
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFFreeModelFileAttributesInfo ( A3DPDFModelFileAttributesData **  ppModelFileAttributesInfo)

Function to free the memory allocated for the information of the 3D model attributes.

Parameters
[in]ppModelFileAttributesInfoThe element information to delete.
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFGenerateJavascriptDocumentHandler ( A3DUTF8Char **  ppcGeneratedJavascript)

Function to generate document handler javascript functions.

Parameters
[out]ppcGeneratedJavascriptgenerated javascript
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFGetModelFileAttributesInfo ( A3DAsmModelFile pModelFile,
A3DRWParamsPrcWriteHelper pPrcWriteHelper,
A3DPDFModelFileAttributesData **  ppModelFileAttributesInfo 
)

Function to get attributes from a modelfile. The function returns an array of elements in the BOM. Each element is the set of components in the assembly associated to the part.

Parameters
[in]pModelFileThe model file to work with.
[in]pPrcWriteHelperUsed to get PRC data such as unique identifiers for PRC nodes.
[out]ppModelFileAttributesInfoa struct that contains all infos about model attributes.
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFGetTypeOfAnnotation ( void *  ppdAnnot,
int *  pType 
)

Function to free the memory allocated for the information of the 3D model attributes.

Parameters
[in]ppdAnnotThe unknown annotation
[out]pTypeThe annotation type
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFUpdateDocumentDataWithViews ( A3DPDFDocument pPdfDoc,
A3DPDFPage pPdfPage,
A3DPDF3DAnnot pPdf3DAnnot,
void *  pPdAnnot3D,
A3DAsmModelFile pModelFile,
A3DRWParamsPrcWriteHelper pA3DRWParamsPrcWriteHelper,
const A3DUTF8Char pcIn3dAttribsFile,
A3DPDFCarouselViewData *  views,
int  viewCount,
const A3DUTF8Char pcApplicationVersion 
)

Function used by Enrich to replace 3D.

Returns
A3D_SUCCESS
Version
9.0
A3DStatus A3DPDFUpdateDocumentFromXml ( A3DPDFDocument pPdfDoc,
XmlManager *  xmlManager,
int  annot3DNumber,
A3DUTF8Char **  pcAnnot3DUid,
A3DPDFModelFileAttributesData **  attributesLst 
)

Function used by Enrich merge PDF.

Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFUpdateTextFieldsData ( void *  pdDoc,
const A3DUTF8Char pcInTextFieldDataFile 
)

Function used by Enrich to fill text fields.

Returns
A3D_SUCCESS
Version
9.1