< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Enumerations | Functions
View Module

View functions. More...

Data Structures

struct  A3DPDFSectionDisplayData
 Structure to define settings for the cross sections display. More...
 
struct  A3DPDFViewData
 Structure to define a Camera View. More...
 

Enumerations

enum  A3DPDFEProjectionMode { kA3DPDFOrthographicMode =0, kA3DPDFPerspectiveMode =1 }
 Projection mode: type of projection. More...
 

Functions

A3DStatus A3DPDFViewCreate (A3DPDFDocument *pDoc, const A3DPDFViewData *pViewData, A3DPDFView **ppView)
 Function to create a camera view. More...
 
A3DStatus A3DPDFViewGetExternalName (A3DPDFView *pView, A3DUTF8Char **ppcViewId)
 Returns the identifier of the view. More...
 

Detailed Description

View functions.

This module describes the functions and structures that allow you to define 3D views on a 3D Annot.

Enumeration Type Documentation

Projection mode: type of projection.

Version
6.0
Enumerator
kA3DPDFOrthographicMode 

Orthographic projection.

kA3DPDFPerspectiveMode 

Perspective projection.

Function Documentation

A3DStatus A3DPDFViewCreate ( A3DPDFDocument pDoc,
const A3DPDFViewData pViewData,
A3DPDFView **  ppView 
)

Function to create a camera view.

The View object is primarily created with this function, and it should be stored in the 3D Artwork with the function A3DPDF3DArtworkAddView.

Parameters
[in,out]pDocThe Document object to work with.
[in]pViewDataThe view parameters.
[out]ppViewThe View object created.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFViewGetExternalName ( A3DPDFView pView,
A3DUTF8Char **  ppcViewId 
)

Returns the identifier of the view.

The identifier may be used by JavaScript or PDF actions to activate a view. It can also be used to generate poster. The function returns a string.

Parameters
[in]pViewThe View object to work with. This object can be retrieved using the function A3DPDF3DArtworkGetViews
[out]ppcViewIdThe identifier as a string.
Returns
A3D_SUCCESS
Version
4.1