< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Macros | Typedefs | Enumerations | Functions
A3DPDFPublishSDK.h File Reference

Header file for the Publish module. More...

Data Structures

struct  A3DPDFRgbColorData
 A3DPDFRgbColorData structure. More...
 
struct  A3DPDFPageData
 A3DPDFPageData structure. More...
 
struct  A3DPDFPageData2
 A3DPDFPageData2 structure. More...
 
struct  A3DPDFRectData
 A3DPDFRectData structure: structure to define a rectangle placement in the PDF page. More...
 
struct  A3DPDFDocumentInformationData
 A3DPDFDocumentInformationData structure. More...
 
struct  A3DPDFTextData
 A3DPDFTextData structure. More...
 
struct  A3DPDFTextDataEx
 A3DPDFTextDataEx structure. More...
 
struct  A3DPDFImageData
 A3DPDFImageData structure. More...
 
struct  A3DPDFLinkData
 A3DPDFLinkData structure. More...
 
struct  A3DPDFTableData
 Structure to define a table. More...
 
struct  A3DPDF3DArtworkData
 A3DPDF3DArtworkData structure. More...
 
struct  A3DPDF3DAnnotData
 A3DPDF3DAnnotData structure: options for the 3D Annot behavior in the PDF. More...
 
struct  A3DPDFFieldData
 A3DPDF3DFieldData structure. More...
 
struct  A3DPDFSnapshotOptionsData
 A3DPDFSnapshotOptionsData structure: options for the snapshot (poster) generation. More...
 
struct  A3DPDFViewData
 Structure to define a Camera View. More...
 
struct  A3DPDFAnimTransformationData
 Structure to define a transformation. More...
 
struct  A3DPDFAnimAppearanceData
 Structure grouping the appearance characteristics. More...
 
struct  A3DPDFAnimCameraData
 Structure grouping the camera characteristics. More...
 
struct  A3DPDFAnimKeyFrameData
 Structure to define a keyframe. More...
 
struct  A3DPDFAnimMotionData
 Structure to define an animation motion. More...
 
struct  A3DPDFTargetEntityData
 Structure to define a target entity. More...
 
struct  A3DPDFAnimMotionData2
 Structure to define an animation motion. Replaces A3DPDFAnimMotionData. More...
 
struct  A3DPDFAnimationData
 Structure to define an animation. More...
 
struct  A3DPDFButtonData
 Structure to define a button field. More...
 
struct  A3DPDFTextFieldData
 Structure to define a text field. More...
 
struct  A3DPDFCheckBoxData
 Structure to define a check box field. More...
 
struct  A3DPDFRadioButtonData
 Structure to define a radio button field. More...
 
struct  A3DPDFListBoxData
 Structure to define a list box field. More...
 
struct  A3DPDFDropDownListData
 Structure to define a drop down list field (combo box) More...
 
struct  A3DPDFDigitalSignatureData
 Structure to define a digital signature field. More...
 

Macros

#define kA3DPDFDocumentPermOpen   0x01
 
#define kA3DPDFDocumentPermSecure   0x02
 
#define kA3DPDFDocumentPermPrint   0x04
 
#define kA3DPDFDocumentPermEdit   0x08
 
#define kA3DPDFDocumentPermCopy   0x10
 
#define kA3DPDFDocumentPermEditNotes   0x20
 
#define kA3DPDFDocumentPermSaveAs   0x40
 
#define kA3DPDFDocumentPermFillandSign   0x100
 
#define kA3DPDFDocumentPermAccessible   0x200
 
#define kA3DPDFDocumentPermDocAssembly   0x400
 
#define kA3DPDFDocumentPermHighPrint   0x800
 
#define kA3DPDFDocumentPermOwner   0x8000
 
#define kA3DPDFDocumentPermFormSubmit   0x10000
 
#define kA3DPDFDocumentPermFormSpawnTempl   0x20000
 
#define kA3DPDFDocumentPermAll   0xFFFFFFFF
 
#define kA3DPDFDocumentPermSettable   (kA3DPDFDocumentPermPrint + kA3DPDFDocumentPermEdit + kA3DPDFDocumentPermCopy + kA3DPDFDocumentPermEditNotes)
 
#define kA3DPDFDocumentPermUser   (kA3DPDFDocumentPermAll - kA3DPDFDocumentPermOpen - kA3DPDFDocumentPermSecure)
 
#define kA3DPDFInterpolateTransformationMatrix   0x00000001
 
#define kA3DPDFInterpolateAppearanceColor   0x00000002
 
#define kA3DPDFInterpolateAppearanceTransparency   0x00000004
 
#define kA3DPDFInterpolateCamera   0x00000008
 

Typedefs

typedef void A3DPDFDocument
 
typedef void A3DPDFPage
 
typedef void A3DPDF3DAnnot
 
typedef void A3DPDF3DStream
 
typedef void A3DPDF3DArtwork
 
typedef void A3DPDFText
 
typedef void A3DPDFImage
 
typedef void A3DPDFLink
 
typedef void A3DPDFView
 
typedef void A3DPDFTable
 
typedef void A3DPDFField
 
typedef void A3DPDFAnimKeyFrame
 
typedef void A3DPDFAnimMotion
 
typedef void A3DPDFAnimation
 
typedef void A3DPDFTargetEntity
 
typedef void A3DPDFButton
 
typedef void A3DPDFTextField
 
typedef void A3DPDFCheckBox
 
typedef void A3DPDFRadioButton
 
typedef void A3DPDFListBox
 
typedef void A3DPDFDropDownList
 
typedef void A3DPDFDigitalSignature
 

Enumerations

enum  A3DPDFEPageSize {
  kA3DPDFPage11x17 =0, kA3DPDFPageA3, kA3DPDFPageA4, kA3DPDFPageA5,
  kA3DPDFPageB4JIS, kA3DPDFPageB5JIS, kA3DPDFPageExecutive, kA3DPDFPageLegal,
  kA3DPDFPageLetter, kA3DPDFPageTabloid, kA3DPDFPageB4ISO, kA3DPDFPageB5ISO,
  kA3DPDFPageCustom
}
 Page size of the PDF document. More...
 
enum  A3DPDFEPageOrientation { kA3DPDFPagePortrait = 0, kA3DPDFPageLandscape }
 Page orientation of the PDF document. More...
 
enum  A3DPDFEFontName {
  kA3DPDFFontTimesRoman =0, kA3DPDFFontTimesItalic, kA3DPDFFontTimesBold, kA3DPDFFontTimesBoldItalic,
  kA3DPDFFontHelvetica, kA3DPDFFontHelveticaOblique, kA3DPDFFontHelveticaBold, kA3DPDFFontHelveticaBoldOblique,
  kA3DPDFFontCourier, kA3DPDFFontCourierOblique, kA3DPDFFontCourierBold, kA3DPDFFontCourierBoldOblique
}
 Different predefined fonts. More...
 
enum  A3DPDFELanguage {
  kA3DPDFASCII, kA3DPDFEastEuropeanRoman, kA3DPDFCyrillic, kA3DPDFGreek,
  kA3DPDFTurkish, kA3DPDFHebrew, kA3DPDFArabic, kA3DPDFBaltic,
  kA3DPDFChineseTraditional, kA3DPDFChineseSimplified, kA3DPDFJapanese, kA3DPDFKorean
}
 Languages supported for text strings. More...
 
enum  A3DPDFEImageFormat {
  kA3DPDFImageFormatUnknown, kA3DPDFImageFormatBmp, kA3DPDFImageFormatPng, kA3DPDFImageFormatJpg,
  kA3DPDFImageFormatBitmapRgbByte, kA3DPDFImageFormatBitmapRgbaByte, kA3DPDFImageFormatBitmapGreyByte, kA3DPDFImageFormatBitmapGreyaByte,
  kA3DPDFImageFormatEmf, kA3DPDFImageFormatUrl, kA3DPDFImageFormatGif, kA3DPDFImageFormatTif,
  kA3DPDFImageFormatPcx, kA3DPDFImageFormatTga, kA3DPDFImageFormatPpm, kA3DPDFImageFormatIlbm,
  kA3DPDFImageFormatCel, kA3DPDFImageFormatRgb, kA3DPDFImageFormatPsd, kA3DPDFImageFormatSoftimagepic
}
 Different image formats. More...
 
enum  A3DPDFELinkHighlightMode { kA3DPDFLinkHighlightNone =0, kA3DPDFLinkHighlightInvert, kA3DPDFLinkHighlightOutline, kA3DPDFLinkHighlightPush }
 Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area) More...
 
enum  A3DPDFEActivateWhen { kA3DPDFActivExplicitActivation =0, kA3DPDFActivPageOpened, kA3DPDFActivPageVisible }
 The circumstances under which the 3D Annot shall be activated. More...
 
enum  A3DPDFEDesactivateWhen { kA3DPDFActivExplicitDesactivation =0, kA3DPDFActivPageClosed, kA3DPDFActivPageNotVisible }
 The circumstances under which the 3D Annot shall be deactivated. More...
 
enum  A3DPDFEAnimationStyle { kA3DPDFAnimStyleNoAnimation =0, kA3DPDFAnimStyleLoop, kA3DPDFAnimStyleBounce }
 Animation Style. More...
 
enum  A3DPDFELighting {
  kA3DPDFLightArtworkCurrent =0, kA3DPDFLightNone, kA3DPDFLightWhite, kA3DPDFLightDay,
  kA3DPDFLightBright, kA3DPDFLightPrimaryColor, kA3DPDFLightNight, kA3DPDFLightBlue,
  kA3DPDFLightRed, kA3DPDFLightCube, kA3DPDFLightCADOptimized, kA3DPDFLightHeadlamp
}
 Lighting. More...
 
enum  A3DPDFERenderingStyle {
  kA3DPDFRenderingTransparentBoundingBox =0, kA3DPDFRenderingSolid, kA3DPDFRenderingTransparent, kA3DPDFRenderingSolidWireframe,
  kA3DPDFRenderingIllustration, kA3DPDFRenderingSolidOutline, kA3DPDFRenderingShadedIllustration, kA3DPDFRenderingBoundingBox,
  kA3DPDFRenderingTransparentBoundingBoxOutline, kA3DPDFRenderingWireframe, kA3DPDFRenderingShadedWireframe, kA3DPDFRenderingTransparentWireframe,
  kA3DPDFRenderingHiddenWireframe, kA3DPDFRenderingVertices, kA3DPDFRenderingShadedVertices
}
 Rendering Style. More...
 
enum  A3DPDFEFieldType {
  kA3DPDFText =0, kA3DPDFButton =1, kA3DPDFDropDown, kA3DPDFListBox,
  kA3DPDFCheckBox, kA3DPDFRadioButton, kA3DPDFDigitalSignature, kA3DPDFBarCode
}
 Field type. More...
 
enum  A3DPDFEProjectionMode { kA3DPDFOrthographicMode =0, kA3DPDFPerspectiveMode =1 }
 Projection mode: type of projection. More...
 
enum  A3DPDFEFormField { kA3DPDFVisible, kA3DPDFHidden, kA3DPDFVisibleNoPrint, kA3DPDFHiddenPrintable }
 Button flags. More...
 
enum  A3DPDFETextOrientation { kA3DPDFNormal, kA3DPDF90, kA3DPDF180, kA3DPDF270 }
 Orientation of the text. More...
 
enum  A3DPDFEThicknessBorder { kA3DPDFThin, kA3DPDFMedium, kA3DPDFThick }
 Thickness of the border of the button. More...
 
enum  A3DPDFELineStyleBorder
 Line style of the border of the button. More...
 
enum  A3DPDFELayoutTextIcon
 Position of the label of the button relative to its icon. More...
 
enum  A3DPDFETextAlignment { kA3DPDFLeft, kA3DPDFCentered, kA3DPDFRight }
 Alignment of the text. More...
 

Functions

A3DStatus A3DPDFInitializePDFLib ()
 This method was deprecated in HOOPS Publish 5.1. Use A3DPDFInitializePDFLibAndResourceDirectory instead. More...
 
A3DStatus A3DPDFInitializePDFLibAndResourceDirectory (const A3DUTF8Char *pcResourceDirectory)
 Function to initialize the PDF Library and set the resource directory. More...
 
A3DStatus A3DPDFTerminatePDFLib ()
 Function to terminate the PDF Library It is important to call this function only once during the life of the application. More...
 
A3DStatus A3DPDFDocumentCreateEmpty (A3DPDFDocument **ppDoc)
 Function to create an empty PDF document. More...
 
A3DStatus A3DPDFDocumentCreateFromPDFFile (const A3DUTF8Char *pcFileName, A3DPDFDocument **ppDoc)
 Function to create a document from a PDF file. More...
 
A3DStatus A3DPDFDocumentCreateUniquePage (A3DPDFDocument *pDoc, const A3DPDFPageData *pPageData, A3DPDFPage **ppPage)
 This method was deprecated in HOOPS Publish 1.10. Use A3DPDFDocumentAppendNewPage instead. More...
 
A3DStatus A3DPDFDocumentCreateUniquePage2 (A3DPDFDocument *pDoc, const A3DPDFPageData2 *pPageData, A3DPDFPage **ppPage)
 This function adds a unique page to an empty PDF document. This function can only be used on a file opened with A3DPDFDocumentCreateEmpty. It can't be used on a file which already contains a page. More...
 
A3DStatus A3DPDFDocumentGetUniquePage (const A3DPDFDocument *pDoc, A3DPDFPage **ppPage)
 Function to get the unique page of the document. More...
 
A3DStatus A3DPDFDocumentGetNumberPages (const A3DPDFDocument *pDoc, A3DInt32 *piNbPages)
 Function to get the number of pages in the document. More...
 
A3DStatus A3DPDFDocumentGetPage (const A3DPDFDocument *pDoc, const A3DInt32 iNumPage, A3DPDFPage **ppPage)
 Function to get a page in the document. More...
 
A3DStatus A3DPDFDocumentRemovePages (const A3DPDFDocument *pDoc, const A3DInt32 iFirstPage, const A3DInt32 iLastPage)
 Function to remove pages in the document. More...
 
A3DStatus A3DPDFDocumentAppendNewPage (A3DPDFDocument *pDoc, const A3DPDFPageData *pPageData, A3DPDFPage **ppPage)
 Appends a new empty page to a document. More...
 
A3DStatus A3DPDFDocumentAppendNewPage2 (A3DPDFDocument *pDoc, const A3DPDFPageData2 *pPageData, A3DPDFPage **ppPage)
 Appends a new empty page to a document. More...
 
A3DStatus A3DPDFDocumentAppendPageFromPDFFile (A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName, A3DPDFPage **ppPage)
 Superseded by A3DPDFDocumentAppendPageFromPDFFileEx in A3DLIBS 4.3 and later. More...
 
A3DStatus A3DPDFDocumentAppendPageFromPDFFileEx (A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName, const A3DBool bRenameFields, A3DPDFPage **ppPage)
 
A3DStatus A3DPDFDocumentSetInformation (A3DPDFDocument *pDoc, const A3DPDFDocumentInformationData *pInformationData)
 Function to set information on the document. These information are visible in the Adobe Reader on the File Properties menu. More...
 
A3DStatus A3DPDFDocumentSetPassword (A3DPDFDocument *pDoc, const A3DUTF8Char *pcUserPassword, const A3DUTF8Char *pcOwnerPassword)
 Function to add user and owner passwords on a document. More...
 
A3DStatus A3DPDFDocumentSetDocumentPermissions (A3DPDFDocument *pDoc, int iPermissions)
 Function to set permissions on a document. More...
 
A3DStatus A3DPDFDocumentAddImageAsIcon (A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)
 Function to store an image in the PDF file in a way it can be used as an icon for PDF fields. More...
 
A3DStatus A3DPDFDocumentAddFileAttachment (A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName, const A3DUTF8Char *pcDescription)
 Function to attach a file to the document. Attachments are visible on the Adobe Reader with the specific navigation pane. In Adobe Reader X version, the Attachments pane can be activated with the menu View / Show/Hide / Navigation Panes / Attachments. More...
 
A3DStatus A3DPDFDocumentAddJavascriptFromString (A3DPDFDocument *pDoc, const A3DUTF8Char *pcScriptName, const A3DUTF8Char *pcJavascriptString)
 Adds a JavaScript to a document. This JavaScript is launched when the file is opened. More...
 
A3DStatus A3DPDFDocumentSave (A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName)
 Function to save the PDF document. More...
 
A3DStatus A3DPDFDocumentClose (A3DPDFDocument *pDoc)
 Function to close the document and free all memory. More...
 
A3DStatus A3DPDFTextCreate (A3DPDFDocument *pDoc, const A3DPDFTextData *pTextData, A3DPDFText **ppText)
 Function to create a text object. More...
 
A3DStatus A3DPDFTextCreateEx (A3DPDFDocument *pDoc, const A3DPDFTextDataEx *pTextDataEx, A3DPDFText **ppText)
 Function to create a text object with extended fonts and languages. More...
 
A3DStatus A3DPDFPageInsertText (A3DPDFPage *pPage, A3DPDFText *pText, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom)
 Function to insert a text in a page. More...
 
A3DStatus A3DPDFPageInsertTextInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFText *pText, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a text in a table. More...
 
A3DStatus A3DPDFImageCreate (A3DPDFDocument *pDoc, const A3DPDFImageData *pImageData, A3DPDFImage **ppImage)
 Function to create a picture image object. More...
 
A3DStatus A3DPDFPageInsertImage (A3DPDFPage *pPage, A3DPDFImage *pImage, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom)
 Function to insert an image in a page. More...
 
A3DStatus A3DPDFLinkCreate (A3DPDFDocument *pDoc, const A3DPDFLinkData *pLinkData, A3DPDFLink **ppLink)
 Function to create a link object. More...
 
A3DStatus A3DPDFPageInsertLink (A3DPDFPage *pPage, A3DPDFLink *pLink, const A3DPDFRectData *pRectData)
 Function to insert a link in a page. More...
 
A3DStatus A3DPDFPageInsertLinkInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFLink *pLink, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a link in a table. More...
 
A3DStatus A3DPDFTableCreate (A3DPDFDocument *pDoc, const A3DPDFTableData *pTableData, A3DPDFTable **ppTable)
 Function to create a table on a PDF page. More...
 
A3DStatus A3DPDFPageInsertTable (A3DPDFPage *pPage, A3DPDFTable *pTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop)
 Function to insert a table in a page. More...
 
A3DStatus A3DPDF3DArtworkCreate (A3DPDFDocument *pDoc, const A3DPDF3DArtworkData *p3DArtworkData, A3DPDF3DArtwork **pp3DArtwork)
 Function to create the 3D Artwork of the 3D Annot. More...
 
A3DStatus A3DPDF3DAnnotCreate (A3DPDFDocument *pDoc, const A3DPDF3DAnnotData *p3DAnnotData, A3DPDF3DAnnot **pp3DAnnot)
 Function to create a 3D Annotation object. More...
 
A3DStatus A3DPDFPageInsert3DAnnot (A3DPDFPage *pPage, const A3DPDF3DAnnot *p3DAnnot, const A3DPDFRectData *pRectData)
 Function to insert a 3D Annot in a page. More...
 
A3DStatus A3DPDFPageFieldSet3DAnnot (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDF3DAnnot *p3DAnnot)
 Function to replace the form field specified with a 3D Annot object. More...
 
A3DStatus A3DPDFPageFieldTextSetValue (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)
 Function to set the text of a text form field. More...
 
A3DStatus A3DPDFPageFieldButtonSetLabel (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)
 Function to set the label of a button form field. More...
 
A3DStatus A3DPDFPageFieldButtonSetIcon (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDFImage *pImage)
 Function to set the icon of a button form field. More...
 
A3DStatus A3DPDFPageFieldListAddItem (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcItemValue, const A3DUTF8Char *pcItemExportValue)
 Function to add an item to a form field of type list. More...
 
A3DStatus A3DPDFPageFieldSetVisibility (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DBool bIsVisible)
 Function to set the visibility of a form field. More...
 
A3DStatus A3DPDFPageFieldSetActionJavascriptFromFile (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcFileName)
 This method was deprecated in HOOPS Publish 1.1. Use A3DPDFPageFieldSetActionJavascriptFromString instead. More...
 
A3DStatus A3DPDFPageFieldSetActionJavascriptFromString (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcJavascriptString)
 Function to attach JavaScript to a form field. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFPageGetFields (A3DPDFPage *pPage, A3DInt32 *piNbFields, A3DPDFField ***pppFields)
 Function to retrieve the fields of a PDF page. The fields supported are only form fields created with Acrobat. LiveCycle Designer fields (XFA) are not supported. More...
 
A3DStatus A3DPDFFieldGetInformation (A3DPDFField *pField, A3DPDFFieldData *pFieldData)
 Function to retrieve useful information regarding a field of a document. More...
 
A3DStatus A3DPDF3DStreamCreateFromModelFileAsPRC (A3DPDFDocument *pDoc, A3DAsmModelFile *pModelFile, const A3DRWParamsExportPrcData *pParamsExportData, A3DPDF3DStream **pp3DStream, A3DRWParamsPrcWriteHelper **ppPrcWriteHelper)
 Function to create a PRC Stream from a Model File. More...
 
A3DStatus A3DPDF3DStreamCreateFromModelFileAsU3D (A3DPDFDocument *pDoc, A3DAsmModelFile *pModelFile, const A3DRWParamsExportU3DData *pParamsExportData, A3DPDF3DStream **pp3DStream)
 Function to create a U3D Stream from Model File. More...
 
A3DStatus A3DPDF3DStreamCreateFromFile (A3DPDFDocument *pDoc, A3DUTF8Char *pcFilePath, const bool bIsPRC, A3DPDF3DStream **pp3DStream)
 Function to create a Stream from a file. More...
 
A3DStatus A3DPDFMakeSnapshotFromModelFile (A3DAsmModelFile *pModelFile, const A3DPDFSnapshotOptionsData *pSnapshotOptionsData, const A3DUTF8Char *pcOutputFilename)
 Function to create the poster of the 3D Annotation. More...
 
A3DStatus A3DPDFViewCreate (A3DPDFDocument *pDoc, const A3DPDFViewData *pViewData, A3DPDFView **ppView)
 Function to create a camera view. More...
 
A3DStatus A3DPDF3DArtworkAddView (A3DPDF3DArtwork *p3DArtwork, const A3DPDFView *pView)
 Adds a view on the 3D Annot. More...
 
A3DStatus A3DPDF3DArtworkGetViews (A3DPDF3DArtwork *p3DArtwork, A3DUns32 *puiNbViews, A3DPDFView ***pppViews)
 Returns the views objects stored in the artwork. More...
 
A3DStatus A3DPDFViewGetExternalName (A3DPDFView *pView, A3DUTF8Char **ppcViewId)
 Returns the identifier of the view. More...
 
A3DStatus A3DPDF3DArtworkGetBoundingSphere (A3DPDF3DArtwork *p3DArtwork, A3DDouble *pdRadius, A3DVector3dData *pCenter)
 Get the bounding sphere of the default view of the 3D Artwork. More...
 
A3DStatus A3DPDFAnimKeyFrameCreate (const A3DPDFAnimKeyFrameData *pKeyFrameData, A3DPDFAnimKeyFrame **ppKeyFrame)
 Function to create a keyframe. More...
 
A3DStatus A3DPDFTargetEntityCreate (const A3DPDFTargetEntityData *pTargetData, A3DPDFTargetEntity **ppTargetEntity)
 Structure to define a target entity of a motion. More...
 
A3DStatus A3DPDFAnimMotionCreate (const A3DPDFAnimMotionData *pMotionData, A3DPDFAnimMotion **ppAnimationMotion)
 Function to create an animation motion. More...
 
A3DStatus A3DPDFAnimMotionCreate2 (const A3DPDFAnimMotionData2 *pMotionData, A3DPDFAnimMotion **ppAnimationMotion)
 Function to create an animation motion. Replaces A3DPDFAnimMotionCreate. More...
 
A3DStatus A3DPDFAnimationCreate (const A3DPDFAnimationData *pAnimationData, A3DPDFAnimation **ppAnimation)
 Function to create an animation. More...
 
A3DStatus A3DPDF3DArtworkEditAnimationJavascript (A3DPDF3DArtwork *p3DArtwork, A3DUTF8Char *pcJavascriptFile, A3DBool bUseAnimationFile)
 Debug function to edit the JavaScript stream corresponding to the animation data in a file. If bUseAnimationFile is set to false, the 'standard' JavaScript of the animation will be created from the animation data. If true, the output file will be used instead of the animation data. To use the new content, the code execution should be stopped after the call to this function, then the code modified, then the execution restarted. This function must be called before A3DPDF3DAnnotCreate. More...
 
A3DStatus A3DPDFGetEntitiesFromName (A3DAsmModelFile *pModelFile, A3DInt32 iNamesSize, A3DUTF8Char **ppNames, A3DInt32 *piIndexes, A3DPDFTargetEntity ****ppTargetEntities, A3DInt32 **ppiDataSizes)
 Utility function to retrieve the targets from their names. More...
 
A3DStatus A3DPDFDefineViewCarousel (A3DPDFDocument *pDoc, A3DPDFPage *pPage, A3DPDF3DAnnot *pAnnot, A3DAsmModelFile *pModelFile, A3DInt32 iNumberOfButtons, A3DUTF8Char **ppButtonsNames, A3DUTF8Char *pPreviousButtonName, A3DUTF8Char *pNextButtonName, A3DInt32 iNumberOfViews, A3DPDFView **ppViews, A3DPDFImage **ppImages, A3DInt32 iScrollStep)
 Function to create a 'standard' view carousel and position it in the PDF document. The PDF document must contain the buttons for the views and the buttons to go to the next and the previous view. More...
 
A3DStatus A3DPDFButtonCreate (A3DPDFDocument *pDoc, const A3DPDFButtonData *pButtonData, A3DPDFButton **ppButton)
 Function to create a button. More...
 
A3DStatus A3DPDFPageInsertButton (A3DPDFPage *pPage, A3DPDFButton *pButton, const A3DPDFRectData *pRectData)
 Function to insert a button in a page. More...
 
A3DStatus A3DPDFPageInsertButtonInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFButton *pButton, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a button in a table. More...
 
A3DStatus A3DPDFDefineSlideTable (A3DPDFDocument *pDoc, A3DPDFPage *pPage, const A3DInt32 iPosLeft, const A3DInt32 iPosTop, A3DUTF8Char *pcHtmlFrameTable, A3DUTF8Char *pcHtmlFrameStyle, A3DUTF8Char *pPreviousButtonName, A3DUTF8Char *pNextButtonName, A3DInt32 iNbTextRows, A3DInt32 iNbTextCols, A3DPDFTextField ***ppTexts, A3DBool bHasHeader)
 Function to create a slide table. This is a table with a fixed size, and two buttons to scroll the rows of the table. The frame of the table is specified through html definition and printed as-is on the page. Then the text data is populated dynamically from an array of texts specified. The table MUST be of simple shape, with the same number of rows for each columns. Optionally, a header can figure in the table frame at first row. In this case, the header content (text) must not be part of the text data. The text data defines the text content, as well as text format attributes (font, font size, and text color). All rows must have the same text attributes, so that only the first row of text data is used internally to get the text format. More...
 
A3DStatus A3DPDFTextFieldCreate (A3DPDFDocument *pDoc, const A3DPDFTextFieldData *pTextFieldData, A3DPDFTextField **ppTextField)
 Function to create a text field. More...
 
A3DStatus A3DPDFPageInsertTextField (A3DPDFPage *pPage, A3DPDFTextField *pTextField, const A3DPDFRectData *pRectData)
 Function to insert a text field in a page. More...
 
A3DStatus A3DPDFPageInsertTextFieldInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFTextField *pTextField, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a text field in a table. More...
 
A3DStatus A3DPDFCheckBoxCreate (A3DPDFDocument *pDoc, const A3DPDFCheckBoxData *pCheckBoxData, A3DPDFCheckBox **ppCheckBox)
 Function to create a CheckBox. More...
 
A3DStatus A3DPDFPageInsertCheckBox (A3DPDFPage *pPage, A3DPDFCheckBox *pCheckBox, const A3DPDFRectData *pRectData)
 Function to insert a CheckBox in a page. More...
 
A3DStatus A3DPDFRadioButtonCreate (A3DPDFDocument *pDoc, const A3DPDFRadioButtonData *pRadioButtonData, A3DPDFRadioButton **ppRadioButton)
 Function to create a RadioButton. More...
 
A3DStatus A3DPDFPageInsertRadioButton (A3DPDFPage *pPage, A3DPDFRadioButton *pRadioButton, const A3DPDFRectData *pRectData)
 Function to insert a RadioButton in a page. More...
 
A3DStatus A3DPDFListBoxCreate (A3DPDFDocument *pDoc, const A3DPDFListBoxData *pListBoxData, A3DPDFListBox **ppListBox)
 Function to create a ListBox. More...
 
A3DStatus A3DPDFPageInsertListBox (A3DPDFPage *pPage, A3DPDFListBox *pListBox, const A3DPDFRectData *pRectData)
 Function to insert a ListBox in a page. More...
 
A3DStatus A3DPDFDropDownListCreate (A3DPDFDocument *pDoc, const A3DPDFDropDownListData *pDropDownListData, A3DPDFDropDownList **ppDropDownList)
 Function to create a DropDownList (combo box) More...
 
A3DStatus A3DPDFPageInsertDropDownList (A3DPDFPage *pPage, A3DPDFDropDownList *pDropDownList, const A3DPDFRectData *pRectData)
 Function to insert a DropDownList (combo box) in a page. More...
 
A3DStatus A3DPDFDigitalSignatureCreate (A3DPDFDocument *pDoc, const A3DPDFDigitalSignatureData *pDigitalSignatureData, A3DPDFDigitalSignature **ppDigitalSignature)
 Function to create a DigitalSignature. More...
 
A3DStatus A3DPDFPageInsertDigitalSignature (A3DPDFPage *pPage, A3DPDFDigitalSignature *pDigitalSignature, const A3DPDFRectData *pRectData)
 Function to insert a DigitalSignature in a page. More...
 

Detailed Description

Header file for the Publish module.

Author
Tech Soft 3D
Version
8.0
Date
October 2014
Copyright (c) 2014 by Tech Soft 3D, LLC. All rights reserved.