A3DPDFEnums.h

A3D SDK Enumerations and static values.

Author

Tech Soft 3D

Version

23.0

Date

January 2023

Copyright (c) 2010 - 2023 by Tech Soft 3D, Inc. All rights reserved.

Content

Macro definitions

kA3DTypePDFWidgetRoot

kA3DTypePDFField

kA3DTypePDFHighLevelWidget

kA3DPDFDocumentPermOpen

kA3DPDFDocumentPermSecure

kA3DPDFDocumentPermPrint

kA3DPDFDocumentPermEdit

kA3DPDFDocumentPermCopy

kA3DPDFDocumentPermEditNotes

kA3DPDFDocumentPermSaveAs

kA3DPDFDocumentPermFillandSign

kA3DPDFDocumentPermAccessible

kA3DPDFDocumentPermDocAssembly

kA3DPDFDocumentPermHighPrint

kA3DPDFDocumentPermOwner

kA3DPDFDocumentPermFormSubmit

kA3DPDFDocumentPermFormSpawnTempl

kA3DPDFDocumentPermAll

kA3DPDFDocumentPermSettable

kA3DPDFDocumentPermUser

kA3DPDFDocumentPermNone

kA3DPDFSaveFull

kA3DPDFSaveOptimized

kA3DPDFSaveOptimizeFonts

kA3DPDFSaveCopy

MAX_FIELD_NAME

kA3DPDFInterpolateTransformationMatrix

kA3DPDFInterpolateAppearanceColor

kA3DPDFInterpolateAppearanceTransparency

kA3DPDFInterpolateCamera

kA3DPDFTableFor3DViewsCustom

kA3DPDFTableFor3DViewsAll

kA3DPDFTableFor3DViewsComputePosters

kA3DPDFNoFilter

kA3DPDFFilterPDFDefaultView

kA3DPDFFilterPDFViewsExceptDefault

kA3DPDFFilterNativeViews

kA3DPDFFilterSubAssemblyViews

kA3DWebOutFormatHtml

Output format flag when exporting for web.

kA3DWebOutFormatScs

kA3DWebOutFormatPrc

kA3DWebOfflineShow3DToolbar

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

kA3DWebOfflineShow3DModelView

kA3DWebOfflineShowViewNavigation

kA3DWebOfflineDefaultOptions

kA3DPDFUnknownStreamIdentifier

Special identifier value for A3DStream3DPDFData .

Enumerators

A3DPDFEWidgetType

Enumerations for PDF Widget Types This enumeration defines a unique type for each PDF widget.

A3DPDFEPageSize

Page size of the PDF document.

A3DPDFEPageOrientation

Page orientation of the PDF document.

A3DPDFEEncryptContent

Options to encrypt document content.

A3DPDFEFontName

Different predefined fonts.

A3DPDFELanguage

Languages supported for text strings.

A3DPDFETableTextHorizontalAlign

Horizontal alignements supported for text strings in a table.

A3DPDFETableTextVerticalAlign

Vertical alignements supported for text strings in a table.

A3DPDFEImageFormat

The following image formats are available in HOOPS.

A3DPDFELinkHighlightMode

Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area)

A3DPDFEActivateWhen

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

A3DPDFEDesactivateWhen

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

A3DPDFEAnimationStyle

Animation Style.

A3DPDFELighting

Lighting.

A3DPDFERenderingStyle

Rendering Style.

A3DPDFEEventActionType

Set of events that can trigger the execution of an action.

A3DPDFEFieldType

Field type.

A3DPDFEModelFileNodeType

ModelFileNode type: type of node in a modelfile.

A3DPDFEProjectionMode

Projection mode: type of projection.

A3DPDFEFormField

Field flags.

A3DPDFETextOrientation

Orientation of the text in a field.

A3DPDFEThicknessBorder

Thickness of the border of a field.

A3DPDFELineStyleBorder

Line style of the border of a field.

A3DPDFELayoutTextIcon

Position of the label of the button relative to its icon.

A3DPDFETextAlignment

Alignment of the text.

A3DPDFEGraphicType

Graphic types.

A3DPDFEWidgetTargetBehaviour

Types of behaviours for a widget when targetted from another widget.

A3DPDFEDirection

Direction of scrolling for a widget (usually View Carousel)

A3DPDFEColumnType

Type of content of the column.

A3DWebOutPdfFormat

Output format enumeration for the pdf structure when exporting for web.

A3DWebEHtmlOutputMode

output mode for html export

A3DPDFEPlaybackControlsSkin

Type of skins for playback controls of rich media annot.

Macro definitions

kA3DTypePDFWidgetRoot

This type does not correspond to any widget.

kA3DTypePDFField

Abstract Types for fields.

kA3DTypePDFHighLevelWidget

Abstract Types for High Level widgets.

kA3DPDFDocumentPermOpen

The user can open and decrypt the document.

kA3DPDFDocumentPermSecure

The user can change the document’s security settings.

kA3DPDFDocumentPermPrint

The user can print the document. Page Setup access is unaffected by this permission, since that affects Acrobat’s preferences - not the document’s. In the Document Security dialog, this corresponds to the Printing entry.

kA3DPDFDocumentPermEdit

The user can edit the document more than adding or modifying text notes (see also kA3DPDFDocumentPermEditNotes). In the Document Security dialog, this corresponds to the Changing the Document entry.

kA3DPDFDocumentPermCopy

The user can copy information from the document to the clipboard. In the document restrictions, this corresponds to the Content Copying or Extraction entry.

kA3DPDFDocumentPermEditNotes

The user can add, modify, and delete text notes (see also kA3DPDFDocumentPermEdit). In the document restrictions, this corresponds to the Authoring Comments and Form Fields entry.

kA3DPDFDocumentPermSaveAs

The user can perform a Save As…. If both kA3DPDFDocumentPermEdit and kA3DPDFDocumentPermEditNotes are disallowed, Save will be disabled but Save As… will be enabled. The Save As… menu item is not necessarily disabled even if the user is not permitted to perform a Save As…

kA3DPDFDocumentPermFillandSign

Overrides other kA3DPDFDocumentPerm bits. It allows the user to fill in or sign existing form or signature fields.

kA3DPDFDocumentPermAccessible

Overrides kA3DPDFDocumentPermCopy to enable the Accessibility API. If a document is saved in Rev2 format (Acrobat 4.0 compatible), only the kA3DPDFDocumentPermCopy bit is checked to determine the Accessibility API state.

kA3DPDFDocumentPermDocAssembly

Overrides various kA3DPDFDocumentPermEdit bits and allows the following operations: page insert/delete/rotate and create bookmark and thumbnail.

kA3DPDFDocumentPermHighPrint

This bit is a supplement to kA3DPDFDocumentPermPrint. If it is clear (disabled) only low quality printing (Print As Image) is allowed. On UNIX platforms where Print As Image doesn’t exist, printing is disabled.

kA3DPDFDocumentPermOwner

The user is permitted to perform all operations, regardless of the permissions specified by the document. Unless this permission is set, the document’s permissions will be reset to those in the document after a full save.

kA3DPDFDocumentPermFormSubmit

This should be set if the user can submit forms outside of the browser. This bit is a supplement to kA3DPDFDocumentPermFillandSign.

kA3DPDFDocumentPermFormSpawnTempl

This should be set if the user can spawn template pages. This bit will allow page template spawning even if kA3DPDFDocumentPermEdit and kA3DPDFDocumentPermEditNotes are clear.

kA3DPDFDocumentPermAll

All permissions.

kA3DPDFDocumentPermSettable

The OR of all operations that can be set by the user in the security restrictions (kA3DPDFDocumentPermPrint + kA3DPDFDocumentPermEdit + kA3DPDFDocumentPermCopy + kA3DPDFDocumentPermEditNotes).

kA3DPDFDocumentPermUser

All permissions. These values are to have all items unallowed, at least all items visible in Acrobat and Acrobat Reader dialog boxes.

kA3DPDFDocumentPermNone

All visible permissions unallowed.

kA3DPDFSaveFull

Basic level (equivalent to a call to A3DPDFDocumentSave).

kA3DPDFSaveOptimized

Adds misc optimizations for saving.

kA3DPDFSaveOptimizeFonts

Adds optimization on fonts definition. This can involve substantial memory and CPU overhead.

kA3DPDFSaveCopy

Save a copy of the document. If this flag is not used, the file is locked until A3DPDFDocumentClose is called.

MAX_FIELD_NAME

The maximum size (in bytes) of a field name in A3DPDFFieldData

kA3DPDFInterpolateTransformationMatrix

Transformation matrix is interpolated.

kA3DPDFInterpolateAppearanceColor

Color is interpolated.

kA3DPDFInterpolateAppearanceTransparency

Transparency is interpolated.

kA3DPDFInterpolateCamera

Camera is interpolated.

kA3DPDFTableFor3DViewsCustom

The detail of views are passed as an argument to the function.

kA3DPDFTableFor3DViewsAll

All views are stored in the table.

kA3DPDFTableFor3DViewsComputePosters

The posters for views are automatically generated during table creation.

kA3DPDFNoFilter

All views, (the native views and the PDF views

kA3DPDFFilterPDFDefaultView

The PDF default view is filtered using the kA3DGraphicsRemoved from A3DGraphicsData structure

kA3DPDFFilterPDFViewsExceptDefault

The PDF views are filtered using the kA3DGraphicsRemoved from A3DGraphicsData structure, ony the default PDF is excluded

kA3DPDFFilterNativeViews

Native views are filtered using the kA3DGraphicsRemoved from A3DGraphicsData structure

kA3DPDFFilterSubAssemblyViews

The PDF default views not on the root assembly are filtered using the kA3DGraphicsRemoved from A3DGraphicsData structure

kA3DWebOutFormatHtml

Output format flag when exporting for web.

Version

12.0 Annotation 3D are exported into html files.

kA3DWebOutFormatScs

Annotation 3D are exported into scs files.

kA3DWebOutFormatPrc

Annotation 3D are exported into prc files (only needed to integrate Communicator in streaming mode).

kA3DWebOfflineShow3DToolbar

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

Version

12.0 The 3D Tool bar is displayed for each Annotation 3D.

kA3DWebOfflineShow3DModelView

The 3D Model View is displayed for each Annotation 3D.

kA3DWebOfflineShowViewNavigation

A widget to navigate through views is displayed for each Annotation 3D.

kA3DWebOfflineDefaultOptions

Default options set when initializing the flags.

kA3DPDFUnknownStreamIdentifier

Special identifier value for A3DStream3DPDFData.

Version

1

Enumerators

enum A3DPDFEWidgetType

Enumerations for PDF Widget Types This enumeration defines a unique type for each PDF widget.

Version

10.0

Values:

enumerator kA3DTypePDFWidgetUnknown
enumerator kA3DTypeFieldText

Acrobat Field Text.

enumerator kA3DTypeFieldButton

Acrobat Field Button.

See also

Button Module

enumerator kA3DTypeFieldCheckBox

Acrobat Field Check Box.

See also

Check Box Module

enumerator kA3DTypeFieldRadioButton

Acrobat Field Radio Button.

enumerator kA3DTypeFieldListBox

Acrobat Field List Box.

See also

ListBox Module

enumerator kA3DTypeFieldDropDownList

Acrobat Field Drop Down List (also named Combo Box).

enumerator kA3DTypeFieldDigitalSignature

Acrobat Field Digital Signature.

enumerator kA3DType3DViewCarousel

High level widget for a View Carousel.

enumerator kA3DTypeScrollTable

High level widget for a Scroll Table.

enumerator kA3DTypeDataFilter

High level widget for a Data Filter.

enumerator kA3DType3DAnnotListNodes

High level widget for a 3DAnnot list of nodes.

enumerator kA3DType3DAnnotListViews

High level widget for a 3DAnnot list of views.

enum A3DPDFEPageSize

Page size of the PDF document.

Version

4.1

Values:

enumerator kA3DPDFPage11x17

Standard 11*17 format. size in points: 792 * 1224.

enumerator kA3DPDFPageA3

Standard A3 format. size in points: 842 * 1190.

enumerator kA3DPDFPageA4

Standard A4 format. size in points: 595 * 842.

enumerator kA3DPDFPageA5

Standard A5 format. size in points: 420 * 595.

enumerator kA3DPDFPageB4JIS

Standard B4 JIS format. size in points: 728 * 1031.

enumerator kA3DPDFPageB5JIS

Standard B5 JIS format. size in points: 515 * 728.

enumerator kA3DPDFPageExecutive

Standard Executive format. size in points: 522 * 756.

enumerator kA3DPDFPageLegal

Standard Legal format. size in points: 612 * 1008.

enumerator kA3DPDFPageLetter

Standard Letter format. size in points: 612 * 792.

enumerator kA3DPDFPageTabloid

Standard Tabloid format. size in points: 792 * 1224.

enumerator kA3DPDFPageB4ISO

Standard B4 ISO format. size in points: 709 * 1001.

enumerator kA3DPDFPageB5ISO

Standard B5 ISO format. size in points: 499 * 709.

enumerator kA3DPDFPageCustom

The page format must be defined using SetPageSize.

enum A3DPDFEPageOrientation

Page orientation of the PDF document.

Version

4.1

Values:

enumerator kA3DPDFPagePortrait

Standard portrait orientation.

enumerator kA3DPDFPageLandscape

Standard landscape orientation.

enum A3DPDFEEncryptContent

Options to encrypt document content.

Version

12.0

Values:

enumerator kA3DPDFEncryptAll

Encrypt all document contents.

enumerator kA3DPDFEncryptAllExceptMetadata

Encrypt all document contents except metadata.

enumerator kA3DPDFEncryptOnlyFileAttachments

Encrypt only file attachments.

enum A3DPDFEFontName

Different predefined fonts.

The PDF format includes a set of 14 standard fonts that can be used without prior definition. HOOPS Publish can set text using the base 14 fonts, even if the fonts do not exist on the local system. These fonts are automatically supported by default by Adobe Reader. Nothing specific is required to display these fonts. The font will be referenced (not embedded), which is an appropriate method for a Base14 font references. Any viewer should be able to display the resulting text, either in the referenced font or in a suitable substitute.

To have the set of characters supported by these fonts, please refer to the PDF norm annex D.2 for latin fonts and D.6 for symbol fonts. Symbol and Zapfindgbats fonts have built-in encodings. Other latin fonts (Times, Courier, Helvetica) are encoded with WinAnsiEncoding.

Version

4.1

Values:

enumerator kA3DPDFFontTimesRoman

Adobe standard Times font, with a normal face.

enumerator kA3DPDFFontTimesItalic

Adobe standard Times font, with a italic face.

enumerator kA3DPDFFontTimesBold

Adobe standard Times font, with a bold face.

enumerator kA3DPDFFontTimesBoldItalic

Adobe standard Times font, with a bold-italic face.

enumerator kA3DPDFFontHelvetica

Adobe standard Helvetica font, with a normal face.

enumerator kA3DPDFFontHelveticaOblique

Adobe standard Helvetica font, with a italic face.

enumerator kA3DPDFFontHelveticaBold

Adobe standard Helvetica font, with a bold face.

enumerator kA3DPDFFontHelveticaBoldOblique

Adobe standard Helvetica font, with a bold-italic face.

enumerator kA3DPDFFontCourier

Adobe standard Courier font, with a normal face.

enumerator kA3DPDFFontCourierOblique

Adobe standard Courier font, with a italic face.

enumerator kA3DPDFFontCourierBold

Adobe standard Courier font, with a bold face.

enumerator kA3DPDFFontCourierBoldOblique

Adobe standard Courier font, with a bold-italic face.

enumerator kA3DPDFFontSymbol

Adobe standard Symbol font.

enumerator kA3DPDFFontZapfDingbats

Adobe standard ZapfDingbats font.

enum A3DPDFELanguage

Languages supported for text strings.

Version

5.0

Values:

enumerator kA3DPDFASCII

ASCII.

enumerator kA3DPDFEastEuropeanRoman

East European Roman.

enumerator kA3DPDFCyrillic

Cyrillic.

enumerator kA3DPDFGreek

Greek.

enumerator kA3DPDFTurkish

Turkish.

enumerator kA3DPDFHebrew

Hebrew.

enumerator kA3DPDFArabic

Arabic.

enumerator kA3DPDFBaltic

Baltic.

enumerator kA3DPDFChineseTraditional

Traditional Chinese.

enumerator kA3DPDFChineseSimplified

Simplified Chinese.

enumerator kA3DPDFJapanese

Japanese.

enumerator kA3DPDFKorean

Korean.

enumerator kA3DPDFSymbol

Symbols.

enumerator kA3DPDFLangAutoDetect

Automatic language detection depending on font used.

enum A3DPDFETableTextHorizontalAlign

Horizontal alignements supported for text strings in a table.

Version

23.0

Values:

enumerator kA3DPDFTableAlignHInherit

The alignement is inherited from upper level style.

enumerator kA3DPDFTableAlignHLeft

The text is left justified.

enumerator kA3DPDFTableAlignHCentered

The text is centered.

enumerator kA3DPDFTableAlignHRight

The text is right justified.

enum A3DPDFETableTextVerticalAlign

Vertical alignements supported for text strings in a table.

Version

23.0

Values:

enumerator kA3DPDFTableAlignVInherit

The alignement is inherited from upper level style.

enumerator kA3DPDFTableAlignVTop

The text is vertically aligned to the top.

enumerator kA3DPDFTableAlignVMiddle

The text is vertically centered.

enumerator kA3DPDFTableAlignVBottom

The text is vertically aligned to the bottom.

enum A3DPDFEImageFormat

The following image formats are available in HOOPS.

Remark

EMF is only supported on Windows.

Remark

Starting from version 2020, some of these formats are not supported anymore. These are Cel, ILBM, PSD, PCX and TIFF.

See also

A3DPDFImageData

Version

4.1

Values:

enumerator kA3DPDFImageFormatUnknown

Undefined format

enumerator kA3DPDFImageFormatBmp

BMP format

enumerator kA3DPDFImageFormatPng

PNG format

enumerator kA3DPDFImageFormatJpg

JPEG format

enumerator kA3DPDFImageFormatBitmapRgbByte

Bitmap RGB format

enumerator kA3DPDFImageFormatBitmapRgbaByte

Bitmap RGBA format

enumerator kA3DPDFImageFormatBitmapGreyByte

Bitmap grey format

enumerator kA3DPDFImageFormatBitmapGreyaByte

Bitmap greya format

enumerator kA3DPDFImageFormatEmf

EMF format, Windows only

enumerator kA3DPDFImageFormatUrl

URL format

enumerator kA3DPDFImageFormatGif

GIF format

enumerator kA3DPDFImageFormatTif

TIFF format, unsupported

enumerator kA3DPDFImageFormatPcx

PCX format, unsupported

enumerator kA3DPDFImageFormatTga

TGA format

enumerator kA3DPDFImageFormatPpm

PPM format

enumerator kA3DPDFImageFormatIlbm

ILBM format, unsupported

enumerator kA3DPDFImageFormatCel

Cel format, unsupported

enumerator kA3DPDFImageFormatRgb

RGB format

enumerator kA3DPDFImageFormatPsd

PSD format, unsupported

enumerator kA3DPDFImageFormatSoftimagepic

Softimagepic format

enum A3DPDFELinkHighlightMode

Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area)

Version

5.2

Values:

enumerator kA3DPDFLinkHighlightNone

No highlighting.

enumerator kA3DPDFLinkHighlightInvert

Invert the contents of the link rectangle.

enumerator kA3DPDFLinkHighlightOutline

Invert the link border.

enumerator kA3DPDFLinkHighlightPush

Display the link as if it were being pushed below the surface of the page.

enum A3DPDFEActivateWhen

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

Version

4.1

Values:

enumerator kA3DPDFActivExplicitActivation

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

enumerator kA3DPDFActivPageOpened

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

enumerator kA3DPDFActivPageVisible

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

enum A3DPDFEDesactivateWhen

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

Version

4.1

Values:

enumerator kA3DPDFActivExplicitDesactivation

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

enumerator kA3DPDFActivPageClosed

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

enumerator kA3DPDFActivPageNotVisible

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

enum A3DPDFEAnimationStyle

Animation Style.

Version

4.1

Values:

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.

enumerator kA3DPDFAnimStyleLoop

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

enumerator kA3DPDFAnimStyleBounce

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

enum A3DPDFELighting

Lighting.

Version

4.1

Values:

enumerator kA3DPDFLightArtworkCurrent

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

enumerator kA3DPDFLightNone

No light.

enumerator kA3DPDFLightWhite

White light.

enumerator kA3DPDFLightDay

Day light.

enumerator kA3DPDFLightBright

Bright light.

enumerator kA3DPDFLightPrimaryColor

Primary color light.

enumerator kA3DPDFLightNight

Night light.

enumerator kA3DPDFLightBlue

Blue light.

enumerator kA3DPDFLightRed

Red light.

enumerator kA3DPDFLightCube

Cube light.

enumerator kA3DPDFLightCADOptimized

CAD Optimized light.

enumerator kA3DPDFLightHeadlamp

Headlamp light.

enum A3DPDFERenderingStyle

Rendering Style.

Version

4.1

Values:

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.

enumerator kA3DPDFRenderingSolid

Displays textured and lit geometric shapes.

enumerator kA3DPDFRenderingTransparent

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

enumerator kA3DPDFRenderingSolidWireframe

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

enumerator kA3DPDFRenderingIllustration

Displays silhouette edges with surfaces, removes obscured lines.

enumerator kA3DPDFRenderingSolidOutline

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

enumerator kA3DPDFRenderingShadedIllustration

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

enumerator kA3DPDFRenderingBoundingBox

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

enumerator 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.

enumerator kA3DPDFRenderingWireframe

Displays only edges in a single color.

enumerator kA3DPDFRenderingShadedWireframe

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

enumerator kA3DPDFRenderingTransparentWireframe

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

enumerator kA3DPDFRenderingHiddenWireframe

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

enumerator kA3DPDFRenderingVertices

Displays only vertices in a single color.

enumerator kA3DPDFRenderingShadedVertices

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

enum A3DPDFEEventActionType

Set of events that can trigger the execution of an action.

The kA3DPDFEventPageOpened and kA3DPDFEventPageClosed event on an annotation object have a similar function in the page object. However, associating these triggers with annotations allows annotation objects to be self-contained. The kA3DPDFEventPageVisible and kA3DPDFEventPageInvisible types allow a distinction between pages that are open and pages that are visible. At any one time, while more than one page may be visible, depending on the page layout.

Version

9.0

Values:

enumerator kA3DPDFEventAutomatic

The action is performed when an event (automatically determined depending on the function called) is triggered. See documentation for function using this.

enumerator kA3DPDFEventPageOpened

An action that shall be performed when the page, or the page containing the annotation, is opened.

enumerator kA3DPDFEventPageClosed

An action that shall be performed when the page, or the page containing the annotation, is closed.

enumerator kA3DPDFEventPageVisible

An action that shall be performed when the page containing the annotation becomes visible.

enumerator kA3DPDFEventPageInvisible

An action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.

enumerator kA3DPDFEventFieldEnter

An action that shall be performed when the cursor enters the annotation’s active area.

enumerator kA3DPDFEventFieldExit

An action that shall be performed when the cursor exits the annotation’s active area.

enumerator kA3DPDFEventFieldMouseDown

An action that shall be performed when the mouse button is pressed inside the annotation’s active area.

enumerator kA3DPDFEventFieldMouseUp

An action that shall be performed when the mouse button is released inside the annotation’s active area.

enumerator kA3DPDFEventFieldFocusIn

An action that shall be performed when the annotation receives the input focus.

enumerator kA3DPDFEventFieldFocusOut

An action that shall be performed when the annotation loses the input focus.

enumerator kA3DPDFEventDocWillClose

An action that shall be performed before closing a document.

enumerator kA3DPDFEventDocWillSave

An action that shall be performed before saving a document.

enumerator kA3DPDFEventDocDidSave

An action that shall be performed after saving a document.

enumerator kA3DPDFEventDocWillPrint

An action that shall be performed before printing a document.

enumerator kA3DPDFEventDocDidPrint

An action that shall be performed after printing a document.

enumerator kA3DPDFEventFieldKeyStroke

An action that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.

enum A3DPDFEFieldType

Field type.

Version

6.0

Values:

enumerator kA3DPDFText

Field of type ‘Text field’.

enumerator kA3DPDFButton

Field of type ‘Button’.

enumerator kA3DPDFDropDown

Field of type ‘Drop-down list’ (also named ‘Combo box’).

enumerator kA3DPDFListBox

Field of type ‘List Box’.

enumerator kA3DPDFCheckBox

Field of type ‘Check Box’.

enumerator kA3DPDFRadioButton

Field of type ‘Radio Button’.

enumerator kA3DPDFDigitalSignature

Field of type ‘Digital Signature’.

enumerator kA3DPDFBarCode

Field of type ‘Barcode’. Not used by Publish.

enum A3DPDFEModelFileNodeType

ModelFileNode type: type of node in a modelfile.

Version

10.0

Values:

enumerator kA3DPDFNodeProductOccurrence

node for a Product occurence.

enumerator kA3DPDFNodeRepresentationItem

node for a mesh (node object that contains geometry).

enumerator kA3DPDFNodePMI

node for a PMI. Stored in the PDF model tree under a ‘3D PMI’ node.

enumerator kA3DPDFNodeRiSet

node for a mesh set. Does not contain any geometry but has children who do.

enumerator kA3DPDFNodeCamera

node for a camera.

enumerator kA3DPDFNodeLight

node for a light.

enum A3DPDFEProjectionMode

Projection mode: type of projection.

Version

6.0

Values:

enumerator kA3DPDFOrthographicMode

Orthographic projection.

enumerator kA3DPDFPerspectiveMode

Perspective projection.

enum A3DPDFEFormField

Field flags.

Version

7.2

Values:

enumerator kA3DPDFVisible

The field is visible and printable.

enumerator kA3DPDFHidden

The field is hidden and not printable.

enumerator kA3DPDFVisibleNoPrint

The field is visible but not printable.

enumerator kA3DPDFHiddenPrintable

The field is hidden but printable.

enum A3DPDFETextOrientation

Orientation of the text in a field.

Version

7.2

Values:

enumerator kA3DPDFNormal

The text has a standard orientation.

enumerator kA3DPDF90

The button is turned 90 from counter clockwise.

enumerator kA3DPDF180

The button is turned 180 from counter clockwise.

enumerator kA3DPDF270

The button is turned 270 from counter clockwise.

enum A3DPDFEThicknessBorder

Thickness of the border of a field.

Version

7.2

Values:

enumerator kA3DPDFThin

The border of the field is thin.

enumerator kA3DPDFMedium

The border of the field is medium size.

enumerator kA3DPDFThick

The border of the field is thin.

enum A3DPDFELineStyleBorder

Line style of the border of a field.

Version

7.2

Values:

enumerator kA3DPDFSolid

Solid line.

enumerator kA3DPDFDashed

Dashed line.

enumerator kA3DPDFBeveled

Beveled line.

enumerator kA3DPDFInset

Inset line.

enumerator kA3DPDFUnderlined

Underlined.

enum A3DPDFELayoutTextIcon

Position of the label of the button relative to its icon.

Version

7.2

Values:

enumerator kA3DPDFLabelOnly

Only the label will be displayed.

enumerator kA3DPDFIconOnly

Only the icon will be displayed.

enumerator kA3DPDFIconTopLabelBottom

The label will be displayed below the icon.

enumerator kA3DPDFLabelTopIconBottom

The label will be displayed above the icon.

enumerator kA3DPDFIconLeftLabelRight

The label will be displayed to the right of the icon.

enumerator kA3DPDFLabelLeftIconRight

The label will be displayed to the left of the icon.

enumerator kA3DPDFLabelOverIcon

The label will be displayed on top of the icon.

enum A3DPDFETextAlignment

Alignment of the text.

Version

7.2

Values:

enumerator kA3DPDFLeft

The text is left justified.

enumerator kA3DPDFCentered

The button is centered.

enumerator kA3DPDFRight

The button is right justified.

enum A3DPDFEGraphicType

Graphic types.

Version

9.1

Values:

enumerator kA3DPDFGraphicLine

Graphic line.

enumerator kA3DPDFGraphicArc

Graphic arc.

enumerator kA3DPDFGraphicBezierCurve

Graphic bezier curve.

enum A3DPDFEWidgetTargetBehaviour

Types of behaviours for a widget when targetted from another widget.

Version

9.2

Values:

enumerator kA3DPDFDataIsolate

Isolate the rows.

enumerator kA3DPDFDataHighlight

Highlight the rows.

enumerator kA3DPDFDataSelect

Select the rows.

enumerator kA3DPDFDataIsolateAndSelect

Isolate the rows, then selects the first item.

enum A3DPDFEDirection

Direction of scrolling for a widget (usually View Carousel)

Version

10.0

Values:

enumerator kA3DPDFHorizontal

Horizontal direction.

enumerator kA3DPDFVertical

Vertical direction.

enum A3DPDFEColumnType

Type of content of the column.

Version

10.2

Values:

enumerator kA3DPDFTextContent

The contents of the column are texts.

enumerator kA3DPDFImageContent

The contents of the column are pictures.

enumerator kA3DPDFCheckBoxContent

The contents of the column are checkboxes.

enum A3DWebOutPdfFormat

Output format enumeration for the pdf structure when exporting for web.

Version

23.0

Values:

enumerator kA3DWebOutPdfFormatXml

The structure of the PDF is exported as an XML file.

enumerator kA3DWebOutPdfFormatJson

The structure of the PDF is exported as a JSON file.

enum A3DWebEHtmlOutputMode

output mode for html export

Version

13.0

Values:

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.

enumerator 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.

enumerator 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.

enum A3DPDFEPlaybackControlsSkin

Type of skins for playback controls of rich media annot.

Version

12.2

Values:

enumerator kA3DPDFSkinOverPlay

Play

enumerator kA3DPDFSkinOverPlayMute

PlayMute

enumerator kA3DPDFSkinOverPlaySeekMute

PlaySeekMute

enumerator kA3DPDFSkinOverPlaySeekStop

PlaySeekStop

enumerator kA3DPDFSkinOverPlayStopSeekMuteVol

PlayStopSeekMuteVol

enumerator kA3DPDFSkinOverAllNoVolNoCaptionNoFull

AllNoVolNoCaptionNoFull

enumerator kA3DPDFSkinOverAllNoFullNoCaption

AllNoFullNoCaption