Module to define a 3D Annotation. More...

Data Structures

struct  A3DPDF3DAnnotData
 A3DPDF3DAnnotData structure: options for the 3D Annot behavior in the PDF. More...
 

Enumerations

enum  A3DPDFEActivateWhen {
  kA3DPDFActivExplicitActivation = 0,
  kA3DPDFActivPageOpened,
  kA3DPDFActivPageVisible
}
 The circumstances under which the 3D Annot shall be activated. More...
 
enum  A3DPDFEAnimationStyle {
  kA3DPDFAnimStyleNoAnimation = 0,
  kA3DPDFAnimStyleLoop,
  kA3DPDFAnimStyleBounce
}
 Animation Style. More...
 
enum  A3DPDFEDesactivateWhen {
  kA3DPDFActivExplicitDesactivation = 0,
  kA3DPDFActivPageClosed,
  kA3DPDFActivPageNotVisible
}
 The circumstances under which the 3D Annot shall be deactivated. 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...
 

Functions

A3DStatus A3DPDF3DAnnotCreate (A3DPDFDocument *pDoc, const A3DPDF3DAnnotData *p3DAnnotData, A3DPDF3DAnnot **pp3DAnnot)
 Function to create a 3D Annotation object. 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 A3DPDFPageInsert3DAnnot (A3DPDFPage *pPage, const A3DPDF3DAnnot *p3DAnnot, const A3DPDFRectData *pRectData)
 Function to insert a 3D Annot in a page. More...
 

Detailed Description

Module to define a 3D Annotation.

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

Enumeration Type Documentation

◆ A3DPDFEActivateWhen

The circumstances under which the 3D Annot shall be activated.

Version
4.1
Enumerator
kA3DPDFActivExplicitActivation 

The 3D Annot shall remain inactive until explicitly activated by a script or user action.

kA3DPDFActivPageOpened 

The 3D Annot shall be activated as soon as the page containing the 3D Annot is opened.

kA3DPDFActivPageVisible 

The 3D Annot shall be activated as soon as any part of the page containing the 3D Annot becomes visible.

◆ A3DPDFEDesactivateWhen

The circumstances under which the 3D Annot shall be deactivated.

Version
4.1
Enumerator
kA3DPDFActivExplicitDesactivation 

The 3D Annot shall remain active until explicitly deactivated by a script or user action.

kA3DPDFActivPageClosed 

The 3D Annot shall be deactivated as soon as the page is closed.

kA3DPDFActivPageNotVisible 

The 3D Annot shall be deactivated as soon as the page containing the 3D Annot becomes invisible.

◆ A3DPDFEAnimationStyle

Animation Style.

Version
4.1
Enumerator
kA3DPDFAnimStyleNoAnimation 

Animations shall not be driven directly by the conforming reader. This value shall be used by documents that are intended to drive animations through an alternate means, such as JavaScript.

kA3DPDFAnimStyleLoop 

This animation style results in a repetitive playthrough of the animation.

kA3DPDFAnimStyleBounce 

This animation style results in a back-and-forth playing of the animation.

◆ A3DPDFELighting

Lighting.

Version
4.1
Enumerator
kA3DPDFLightArtworkCurrent 

The light is defined from the 3D data (in the 3D Artwork).

kA3DPDFLightNone 

No light.

kA3DPDFLightWhite 

White light.

kA3DPDFLightDay 

Day light.

kA3DPDFLightBright 

Bright light.

kA3DPDFLightPrimaryColor 

Primary color light.

kA3DPDFLightNight 

Night light.

kA3DPDFLightBlue 

Blue light.

kA3DPDFLightRed 

Red light.

kA3DPDFLightCube 

Cube light.

kA3DPDFLightCADOptimized 

CAD Optimized light.

kA3DPDFLightHeadlamp 

Headlamp light.

◆ A3DPDFERenderingStyle

Rendering Style.

Version
4.1
Enumerator
kA3DPDFRenderingTransparentBoundingBox 

Displays bounding boxes faces of each node, aligned with the axes of the local coordinate space for that node, with an added level of transparency.

kA3DPDFRenderingSolid 

Displays textured and lit geometric shapes.

kA3DPDFRenderingTransparent 

Displays textured and lit geometric shapes (triangles) with an added level of transparency.

kA3DPDFRenderingSolidWireframe 

Displays textured and lit geometric shapes (triangles) with an added level of transparency, with single color opaque edges on top of it.

kA3DPDFRenderingIllustration 

Displays silhouette edges with surfaces, removes obscured lines.

kA3DPDFRenderingSolidOutline 

Displays silhouette edges with lit and textured surfaces, removes obscured lines.

kA3DPDFRenderingShadedIllustration 

Displays silhouette edges with lit and textured surfaces and an additional emissive term to remove poorly lit areas of the artwork.

kA3DPDFRenderingBoundingBox 

Displays the bounding box edges of each node, aligned with the axes of the local coordinate space for that node.

kA3DPDFRenderingTransparentBoundingBoxOutline 

Displays bounding boxes edges and faces of each node, aligned with the axes of the local coordinate space for that node, with an added level of transparency.

kA3DPDFRenderingWireframe 

Displays only edges in a single color.

kA3DPDFRenderingShadedWireframe 

Displays only edges, though interpolates their color between their two vertices and applies lighting.

kA3DPDFRenderingTransparentWireframe 

Displays textured and lit geometric shapes (triangles) with an added level of transparency, with single color opaque edges on top of it.

kA3DPDFRenderingHiddenWireframe 

Displays edges in a single color, though removes back-facing and obscured edges.

kA3DPDFRenderingVertices 

Displays only vertices in a single color.

kA3DPDFRenderingShadedVertices 

Displays only vertices, though uses their vertex color and applies lighting.

Function Documentation

◆ A3DPDF3DAnnotCreate()

A3DStatus A3DPDF3DAnnotCreate ( A3DPDFDocument pDoc,
const A3DPDF3DAnnotData p3DAnnotData,
A3DPDF3DAnnot **  pp3DAnnot 
)

Function to create a 3D Annotation object.

The 3D Annotation object is primarily created with this function, and it should be inserted on the page with the functions A3DPDFPageInsert3DAnnot or A3DPDFPageFieldSet3DAnnot.

Parameters
[in,out]pDocThe Document object to work with.
[in]p3DAnnotDataThe 3D Annot parameters.
[out]pp3DAnnotThe 3D Annot object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values

◆ A3DPDFPageInsert3DAnnot()

A3DStatus A3DPDFPageInsert3DAnnot ( A3DPDFPage pPage,
const A3DPDF3DAnnot p3DAnnot,
const A3DPDFRectData pRectData 
)

Function to insert a 3D Annot in a page.

Insert a 3D Annot object on the page. Several 3D Annots can be stored on a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]p3DAnnotThe 3D Annot to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS in case of success or an error code
Return values

◆ A3DPDFPageFieldSet3DAnnot()

A3DStatus A3DPDFPageFieldSet3DAnnot ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DPDF3DAnnot p3DAnnot 
)

Function to replace the form field specified with a 3D Annot object.

Several 3D Annots can be stored on a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]p3DAnnotThe 3D Annot to set.
Returns
A3D_SUCCESS in case of success or an error code
Return values