< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Functions
3D Artwork Module

3D Artwork functions More...

Data Structures

struct  A3DPDF3DArtworkData
 A3DPDF3DArtworkData structure. More...
 

Functions

A3DStatus A3DPDF3DArtworkCreate (A3DPDFDocument *pDoc, const A3DPDF3DArtworkData *p3DArtworkData, A3DPDF3DArtwork **pp3DArtwork)
 Function to create the 3D Artwork of the 3D Annot. 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 A3DPDF3DArtworkGetBoundingSphere (A3DPDF3DArtwork *p3DArtwork, A3DDouble *pdRadius, A3DVector3dData *pCenter)
 Get the bounding sphere of the default view of the 3D Artwork. More...
 

Detailed Description

3D Artwork functions

This module describes the functions and structures that allow you to define 3D data in the page.

Function Documentation

A3DStatus A3DPDF3DArtworkCreate ( A3DPDFDocument pDoc,
const A3DPDF3DArtworkData p3DArtworkData,
A3DPDF3DArtwork **  pp3DArtwork 
)

Function to create the 3D Artwork of the 3D Annot.

The 3D Artwork object is primarily created with this function, and it should be stored on the 3D Annot through the structure A3DPDF3DAnnotData.

Parameters
[in,out]pDocThe Document object to work with.
[in]p3DArtworkDataThe 3D Artwork parameters.
[out]pp3DArtworkThe 3D Artwork object created.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDF3DArtworkAddView ( A3DPDF3DArtwork p3DArtwork,
const A3DPDFView pView 
)

Adds a view on the 3D Annot.

The view is a PDF object and can be activated with PDF actions.

Parameters
[in,out]p3DArtworkThe 3D Artwork object to work with.
[in]pViewThe View to be stored on the 3D Annot.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDF3DArtworkGetViews ( A3DPDF3DArtwork p3DArtwork,
A3DUns32 puiNbViews,
A3DPDFView ***  pppViews 
)

Returns the views objects stored in the artwork.

The function returns an array of pointer on views objects. The views returned can be issued from native CAD file, or could have been created with A3DPDF3DArtworkAddView function. Alternatively if no default view is defined, HOOPS Publish automatically creates one. This automatic view is returned at the end of the array.

Parameters
[in]p3DArtworkThe 3D Artwork object to work with.
[out]puiNbViewsThe size of the following array of views.
[out]pppViewsThe array of pointer on views objects created.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDF3DArtworkGetBoundingSphere ( A3DPDF3DArtwork p3DArtwork,
A3DDouble pdRadius,
A3DVector3dData pCenter 
)

Get the bounding sphere of the default view of the 3D Artwork.

Parameters
[in]p3DArtworkThe 3D Artwork object to work with
[out]pdRadiusThe radius of the bounding sphere.
[out]pCenterThe center of the bounding sphere.
Returns
A3D_SUCCESS
Version
5.1