Modules

 Export SCS Module
 (HOOPS Publish Advanced) Structure and function to write a ModelFile as a SCS stream cache file.
 
 Export monolithic HTML Module
 (HOOPS Publish Advanced) Structure and function to write a ModelFile as a monolithic HTML file.
 

Macros

#define kA3DWebOfflineShow3DToolbar   0x000001
 These flags are used to toggle on and off elements when exporting to HTML. More...
 
#define kA3DWebOutFormatHtml   0x01
 Ouput format flag when exporting for web. More...
 

Enumerations

enum  A3DWebEHtmlOutputMode {
  kA3DWebOnline = 0,
  kA3DWebOfflineWithDependencies,
  kA3DWebOfflineSingleFile
}
 output mode for html export More...
 

Functions

A3DStatus A3DConvertPDFToWebFormat (const A3DUTF8Char *pcFileName, const A3DRWParamsExportHtmlData *pParamsExportData, const A3DUTF8Char *pcOutRootDirectory, const A3DUTF8Char *pcOutputName, A3DUns32 iOutFormats)
 Function that export a pdf into a web format. More...
 

Detailed Description

Macro Definition Documentation

◆ kA3DWebOutFormatHtml

#define kA3DWebOutFormatHtml   0x01

Ouput format flag when exporting for web.

Version
12.0Annotation 3D are exported into html files.

◆ kA3DWebOfflineShow3DToolbar

#define kA3DWebOfflineShow3DToolbar   0x000001

These flags are used to toggle on and off elements when exporting to HTML.

See also
A3DRWHtmlOfflineData
A3DRWHtmlOfflineData::m_uiOptionFlags
Version
12.0The 3D Tool bar is displayed for each Annotation 3D.

Enumeration Type Documentation

◆ A3DWebEHtmlOutputMode

output mode for html export

Version
13.0
Enumerator
kA3DWebOnline 

Export creates one xml file and 0 to N html files depending on the number of 3D streams inside the pdf file. This is the best parameter if you host a server for reading the files. This is the default value.

kA3DWebOfflineWithDependencies 

Export creates one root html file per file exported. JavaScript files and CSS files given with the sample are still needed but HTTP server is not required. This is the best parameter if you want to give a lot of files to someone else.

kA3DWebOfflineSingleFile 

Export creates only one html file embedding JavaScript and CSS files. HTTP server is not required. This is the best parameter if you want to give an export to someone else or on mobile devices with poor network connection.

Function Documentation

◆ A3DConvertPDFToWebFormat()

A3DStatus A3DConvertPDFToWebFormat ( const A3DUTF8Char pcFileName,
const A3DRWParamsExportHtmlData pParamsExportData,
const A3DUTF8Char pcOutRootDirectory,
const A3DUTF8Char pcOutputName,
A3DUns32  iOutFormats 
)

Function that export a pdf into a web format.

Parameters
[in]pcFileNameThe pdf path and name to export
[in]pParamsExportDataExport parameters used by each 3D annotation conversion
[in]pcOutRootDirectorythe root directory to save all created files
[in]pcOutputNamethe 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.
[in]iOutFormatsflag that describe in which format the export has to be done (see HTML Module module)
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
12.0