Module to define a 3D Stream to add in a 3D Artwork. More...

Functions

A3DStatus A3DPDF3DStreamCreateFromFile (A3DPDFDocument *pDoc, const A3DUTF8Char *pcFileName, const A3DBool bIsPRC, A3DPDF3DStream **pp3DStream)
 Function to create a Stream from a file. 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...
 

Detailed Description

Module to define a 3D Stream to add in a 3D Artwork.

This module describes the functions and structures that allow you to add a 3D source in a 3D Annot.

Function Documentation

◆ A3DPDF3DStreamCreateFromModelFileAsPRC()

A3DStatus A3DPDF3DStreamCreateFromModelFileAsPRC ( A3DPDFDocument pDoc,
A3DAsmModelFile pModelFile,
const A3DRWParamsExportPrcData pParamsExportData,
A3DPDF3DStream **  pp3DStream,
A3DRWParamsPrcWriteHelper **  ppPrcWriteHelper 
)

Function to create a PRC Stream from a Model File.

The 3D Stream object is primarily created with this function, and it should be stored on the 3D Artwork through the structure A3DPDF3DArtworkData2. This function saves the modelfile in a PRC format, and creates a 3D Stream object from this data.

Parameters
[in]pDocThe Document object to work with.
[in]pModelFileThe Document object to work with.
[in]pParamsExportDataThe PRC export parameters.
[out]pp3DStreamThe 3DStream object created.
[in,out]ppPrcWriteHelperUsed to get PRC data such as unique identifiers of PRC nodes.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
4.1

◆ A3DPDF3DStreamCreateFromModelFileAsU3D()

A3DStatus A3DPDF3DStreamCreateFromModelFileAsU3D ( A3DPDFDocument pDoc,
A3DAsmModelFile pModelFile,
const A3DRWParamsExportU3DData pParamsExportData,
A3DPDF3DStream **  pp3DStream 
)

Function to create a U3D Stream from Model File.

The 3D Stream object is primarily created with this function, and it should be stored on the 3D Artwork through the structure A3DPDF3DArtworkData2. This function saves the modelfile in a U3D format, and creates a 3D Stream object from this data.

Parameters
[in]pDocThe Document object to work with.
[in]pModelFileThe Document object to work with.
[in]pParamsExportDataThe U3D export parameters.
[out]pp3DStreamThe 3DStream object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
4.1

◆ A3DPDF3DStreamCreateFromFile()

A3DStatus A3DPDF3DStreamCreateFromFile ( A3DPDFDocument pDoc,
const A3DUTF8Char pcFileName,
const A3DBool  bIsPRC,
A3DPDF3DStream **  pp3DStream 
)

Function to create a Stream from a file.

Parameters
[in]pDocThe Document object to work with.
[in]pcFileNameThe full file path of a PRC or U3D file.
[in]bIsPRCSpecifies the format of the data (true is for PRC, false if for U3D).
[out]pp3DStreamThe 3DStream object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
4.1