A3DPDFEnums.h File Reference

A3D SDK Enumerations and static values. More...

Macros

#define kA3DPDFDocumentPermAccessible   0x200
 
#define kA3DPDFDocumentPermAll   0xFFFFFFFF
 
#define kA3DPDFDocumentPermCopy   0x10
 
#define kA3DPDFDocumentPermDocAssembly   0x400
 
#define kA3DPDFDocumentPermEdit   0x08
 
#define kA3DPDFDocumentPermEditNotes   0x20
 
#define kA3DPDFDocumentPermFillandSign   0x100
 
#define kA3DPDFDocumentPermFormSpawnTempl   0x20000
 
#define kA3DPDFDocumentPermFormSubmit   0x10000
 
#define kA3DPDFDocumentPermHighPrint   0x800
 
#define kA3DPDFDocumentPermNone   (kA3DPDFDocumentPermAll - kA3DPDFDocumentPermSettable - kA3DPDFDocumentPermAccessible - kA3DPDFDocumentPermFillandSign - kA3DPDFDocumentPermDocAssembly)
 
#define kA3DPDFDocumentPermOpen   0x01
 
#define kA3DPDFDocumentPermOwner   0x8000
 
#define kA3DPDFDocumentPermPrint   0x04
 
#define kA3DPDFDocumentPermSaveAs   0x40
 
#define kA3DPDFDocumentPermSecure   0x02
 
#define kA3DPDFDocumentPermSettable   (kA3DPDFDocumentPermPrint + kA3DPDFDocumentPermEdit + kA3DPDFDocumentPermCopy + kA3DPDFDocumentPermEditNotes)
 
#define kA3DPDFDocumentPermUser   (kA3DPDFDocumentPermAll - kA3DPDFDocumentPermOpen - kA3DPDFDocumentPermSecure)
 
#define kA3DPDFFilterNativeViews   0x04
 
#define kA3DPDFFilterPDFDefaultView   0x01
 
#define kA3DPDFFilterPDFViewsExceptDefault   0x02
 
#define kA3DPDFFilterSubAssemblyViews   0x08
 
#define kA3DPDFInterpolateAppearanceColor   0x00000002
 
#define kA3DPDFInterpolateAppearanceTransparency   0x00000004
 
#define kA3DPDFInterpolateCamera   0x00000008
 
#define kA3DPDFInterpolateTransformationMatrix   0x00000001
 
#define kA3DPDFNoFilter   0x00
 
#define kA3DPDFSaveCopy   0x04
 
#define kA3DPDFSaveFull   0x00
 
#define kA3DPDFSaveOptimized   0x01
 
#define kA3DPDFSaveOptimizeFonts   0x02
 
#define kA3DPDFTableFor3DViewsAll   0x02
 
#define kA3DPDFTableFor3DViewsComputePosters   0x04
 
#define kA3DPDFTableFor3DViewsCustom   0x01
 
#define kA3DPDFUnknownStreamIdentifier   0
 Special identifier value for A3DStream3DPDFData. More...
 
#define kA3DTypePDFField   ( kA3DTypePDFWidgetRoot + 1 )
 
#define kA3DTypePDFHighLevelWidget   ( kA3DTypePDFWidgetRoot + 20 )
 
#define kA3DTypePDFWidgetRoot   0
 
#define kA3DWebOfflineDefaultOptions   (kA3DWebOfflineShow3DToolbar | kA3DWebOfflineShow3DModelView)
 
#define kA3DWebOfflineShow3DModelView   0x000002
 
#define kA3DWebOfflineShow3DToolbar   0x000001
 These flags are used to toggle on and off elements when exporting to HTML. More...
 
#define kA3DWebOfflineShowViewNavigation   0x000004
 
#define kA3DWebOutFormatHtml   0x01
 Ouput format flag when exporting for web. More...
 
#define kA3DWebOutFormatPrc   0x04
 
#define kA3DWebOutFormatScs   0x02
 
#define MAX_FIELD_NAME   1024
 

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  A3DPDFEColumnType {
  kA3DPDFTextContent = 0,
  kA3DPDFImageContent,
  kA3DPDFCheckBoxContent
}
 Type of content of the column. More...
 
enum  A3DPDFEDesactivateWhen {
  kA3DPDFActivExplicitDesactivation = 0,
  kA3DPDFActivPageClosed,
  kA3DPDFActivPageNotVisible
}
 The circumstances under which the 3D Annot shall be deactivated. More...
 
enum  A3DPDFEDirection {
  kA3DPDFHorizontal = 0,
  kA3DPDFVertical
}
 Direction of scrolling for a widget (usually View Carousel) More...
 
enum  A3DPDFEEncryptContent {
  kA3DPDFEncryptAll,
  kA3DPDFEncryptAllExceptMetadata,
  kA3DPDFEncryptOnlyFileAttachments
}
 Options to encrypt document content. More...
 
enum  A3DPDFEEventActionType {
  kA3DPDFEventAutomatic = -1,
  kA3DPDFEventPageOpened = 0,
  kA3DPDFEventPageClosed = 1,
  kA3DPDFEventPageVisible = 2,
  kA3DPDFEventPageInvisible = 3,
  kA3DPDFEventFieldEnter = 4,
  kA3DPDFEventFieldExit = 5,
  kA3DPDFEventFieldMouseDown = 6,
  kA3DPDFEventFieldMouseUp = 7,
  kA3DPDFEventFieldFocusIn = 8,
  kA3DPDFEventFieldFocusOut = 9,
  kA3DPDFEventDocWillClose = 10,
  kA3DPDFEventDocWillSave = 11,
  kA3DPDFEventDocDidSave = 12,
  kA3DPDFEventDocWillPrint = 13,
  kA3DPDFEventDocDidPrint = 14,
  kA3DPDFEventFieldKeyStroke = 15
}
 Set of events that can trigger the execution of an action. More...
 
enum  A3DPDFEFieldType {
  kA3DPDFText = 0,
  kA3DPDFButton = 1,
  kA3DPDFDropDown,
  kA3DPDFListBox,
  kA3DPDFCheckBox,
  kA3DPDFRadioButton,
  kA3DPDFDigitalSignature,
  kA3DPDFBarCode
}
 Field type. More...
 
enum  A3DPDFEFontName {
  kA3DPDFFontTimesRoman = 0,
  kA3DPDFFontTimesItalic,
  kA3DPDFFontTimesBold,
  kA3DPDFFontTimesBoldItalic,
  kA3DPDFFontHelvetica,
  kA3DPDFFontHelveticaOblique,
  kA3DPDFFontHelveticaBold,
  kA3DPDFFontHelveticaBoldOblique,
  kA3DPDFFontCourier,
  kA3DPDFFontCourierOblique,
  kA3DPDFFontCourierBold,
  kA3DPDFFontCourierBoldOblique,
  kA3DPDFFontSymbol,
  kA3DPDFFontZapfDingbats
}
 Different predefined fonts. More...
 
enum  A3DPDFEFormField {
  kA3DPDFVisible,
  kA3DPDFHidden,
  kA3DPDFVisibleNoPrint,
  kA3DPDFHiddenPrintable
}
 Field flags. More...
 
enum  A3DPDFEGraphicType {
  kA3DPDFGraphicLine = 0,
  kA3DPDFGraphicArc,
  kA3DPDFGraphicBezierCurve
}
 Graphic types. More...
 
enum  A3DPDFEImageFormat {
  kA3DPDFImageFormatUnknown,
  kA3DPDFImageFormatBmp,
  kA3DPDFImageFormatPng,
  kA3DPDFImageFormatJpg,
  kA3DPDFImageFormatBitmapRgbByte,
  kA3DPDFImageFormatBitmapRgbaByte,
  kA3DPDFImageFormatBitmapGreyByte,
  kA3DPDFImageFormatBitmapGreyaByte,
  kA3DPDFImageFormatEmf,
  kA3DPDFImageFormatUrl,
  kA3DPDFImageFormatGif,
  kA3DPDFImageFormatTif,
  kA3DPDFImageFormatPcx,
  kA3DPDFImageFormatTga,
  kA3DPDFImageFormatPpm,
  kA3DPDFImageFormatIlbm,
  kA3DPDFImageFormatCel,
  kA3DPDFImageFormatRgb,
  kA3DPDFImageFormatPsd,
  kA3DPDFImageFormatSoftimagepic
}
 The following image formats are available in HOOPS. More...
 
enum  A3DPDFELanguage {
  kA3DPDFASCII,
  kA3DPDFEastEuropeanRoman,
  kA3DPDFCyrillic,
  kA3DPDFGreek,
  kA3DPDFTurkish,
  kA3DPDFHebrew,
  kA3DPDFArabic,
  kA3DPDFBaltic,
  kA3DPDFChineseTraditional,
  kA3DPDFChineseSimplified,
  kA3DPDFJapanese,
  kA3DPDFKorean,
  kA3DPDFSymbol,
  kA3DPDFLangAutoDetect
}
 Languages supported for text strings. More...
 
enum  A3DPDFELayoutTextIcon {
  kA3DPDFLabelOnly,
  kA3DPDFIconOnly,
  kA3DPDFIconTopLabelBottom,
  kA3DPDFLabelTopIconBottom,
  kA3DPDFIconLeftLabelRight,
  kA3DPDFLabelLeftIconRight,
  kA3DPDFLabelOverIcon
}
 Position of the label of the button relative to its icon. More...
 
enum  A3DPDFELighting {
  kA3DPDFLightArtworkCurrent = 0,
  kA3DPDFLightNone,
  kA3DPDFLightWhite,
  kA3DPDFLightDay,
  kA3DPDFLightBright,
  kA3DPDFLightPrimaryColor,
  kA3DPDFLightNight,
  kA3DPDFLightBlue,
  kA3DPDFLightRed,
  kA3DPDFLightCube,
  kA3DPDFLightCADOptimized,
  kA3DPDFLightHeadlamp
}
 Lighting. More...
 
enum  A3DPDFELineStyleBorder {
  kA3DPDFSolid,
  kA3DPDFDashed,
  kA3DPDFBeveled,
  kA3DPDFInset,
  kA3DPDFUnderlined
}
 Line style of the border of a field. More...
 
enum  A3DPDFELinkHighlightMode {
  kA3DPDFLinkHighlightNone = 0,
  kA3DPDFLinkHighlightInvert,
  kA3DPDFLinkHighlightOutline,
  kA3DPDFLinkHighlightPush
}
 Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area) More...
 
enum  A3DPDFEModelFileNodeType {
  kA3DPDFNodeProductOccurrence = 0,
  kA3DPDFNodeRepresentationItem = 1,
  kA3DPDFNodePMI = 2,
  kA3DPDFNodeRiSet = 3,
  kA3DPDFNodeCamera = 4,
  kA3DPDFNodeLight = 5
}
 ModelFileNode type: type of node in a modelfile. More...
 
enum  A3DPDFEPageOrientation {
  kA3DPDFPagePortrait = 0,
  kA3DPDFPageLandscape
}
 Page orientation of the PDF document. More...
 
enum  A3DPDFEPageSize {
  kA3DPDFPage11x17 = 0,
  kA3DPDFPageA3,
  kA3DPDFPageA4,
  kA3DPDFPageA5,
  kA3DPDFPageB4JIS,
  kA3DPDFPageB5JIS,
  kA3DPDFPageExecutive,
  kA3DPDFPageLegal,
  kA3DPDFPageLetter,
  kA3DPDFPageTabloid,
  kA3DPDFPageB4ISO,
  kA3DPDFPageB5ISO,
  kA3DPDFPageCustom
}
 Page size of the PDF document. More...
 
enum  A3DPDFEPlaybackControlsSkin {
  kA3DPDFSkinOverPlay = 0,
  kA3DPDFSkinOverPlayMute,
  kA3DPDFSkinOverPlaySeekMute,
  kA3DPDFSkinOverPlaySeekStop,
  kA3DPDFSkinOverPlayStopSeekMuteVol,
  kA3DPDFSkinOverAllNoVolNoCaptionNoFull,
  kA3DPDFSkinOverAllNoFullNoCaption
}
 Type of skins for playback controls of rich media annot. More...
 
enum  A3DPDFEProjectionMode {
  kA3DPDFOrthographicMode = 0,
  kA3DPDFPerspectiveMode = 1
}
 Projection mode: type of projection. More...
 
enum  A3DPDFERenderingStyle {
  kA3DPDFRenderingTransparentBoundingBox = 0,
  kA3DPDFRenderingSolid,
  kA3DPDFRenderingTransparent,
  kA3DPDFRenderingSolidWireframe,
  kA3DPDFRenderingIllustration,
  kA3DPDFRenderingSolidOutline,
  kA3DPDFRenderingShadedIllustration,
  kA3DPDFRenderingBoundingBox,
  kA3DPDFRenderingTransparentBoundingBoxOutline,
  kA3DPDFRenderingWireframe,
  kA3DPDFRenderingShadedWireframe,
  kA3DPDFRenderingTransparentWireframe,
  kA3DPDFRenderingHiddenWireframe,
  kA3DPDFRenderingVertices,
  kA3DPDFRenderingShadedVertices
}
 Rendering Style. More...
 
enum  A3DPDFETextAlignment {
  kA3DPDFLeft,
  kA3DPDFCentered,
  kA3DPDFRight
}
 Alignment of the text. More...
 
enum  A3DPDFETextOrientation {
  kA3DPDFNormal,
  kA3DPDF90,
  kA3DPDF180,
  kA3DPDF270
}
 Orientation of the text in a field. More...
 
enum  A3DPDFEThicknessBorder {
  kA3DPDFThin,
  kA3DPDFMedium,
  kA3DPDFThick
}
 Thickness of the border of a field. More...
 
enum  A3DPDFEWidgetTargetBehaviour {
  kA3DPDFDataIsolate = 0,
  kA3DPDFDataHighlight,
  kA3DPDFDataSelect,
  kA3DPDFDataIsolateAndSelect
}
 Types of behaviours for a widget when targetted from another widget. More...
 
enum  A3DPDFEWidgetType { ,
  kA3DTypeFieldText = kA3DTypePDFField + 1,
  kA3DTypeFieldButton = kA3DTypePDFField + 2,
  kA3DTypeFieldCheckBox = kA3DTypePDFField + 3,
  kA3DTypeFieldRadioButton = kA3DTypePDFField + 4,
  kA3DTypeFieldListBox = kA3DTypePDFField + 5,
  kA3DTypeFieldDropDownList = kA3DTypePDFField + 6,
  kA3DTypeFieldDigitalSignature = kA3DTypePDFField + 7,
  kA3DType3DViewCarousel = kA3DTypePDFHighLevelWidget + 1,
  kA3DTypeScrollTable = kA3DTypePDFHighLevelWidget + 2,
  kA3DTypeDataFilter = kA3DTypePDFHighLevelWidget + 3,
  kA3DType3DAnnotListNodes = kA3DTypePDFHighLevelWidget + 4,
  kA3DType3DAnnotListViews = kA3DTypePDFHighLevelWidget + 5
}
 Enumerations for PDF Widget Types This enumeration defines a unique type for each PDF widget. More...
 
enum  A3DWebEHtmlOutputMode {
  kA3DWebOnline = 0,
  kA3DWebOfflineWithDependencies,
  kA3DWebOfflineSingleFile
}
 output mode for html export More...
 

Detailed Description

A3D SDK Enumerations and static values.

Author
Tech Soft 3D
Version
22.1
Date
April 2022
Copyright (c) 2010 - 2022 by Tech Soft 3D, Inc. All rights reserved.

Macro Definition Documentation

◆ MAX_FIELD_NAME

#define MAX_FIELD_NAME   1024

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

◆ kA3DWebOutFormatScs

#define kA3DWebOutFormatScs   0x02

Annotation 3D are exported into scs files.

◆ kA3DWebOutFormatPrc

#define kA3DWebOutFormatPrc   0x04

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

◆ kA3DWebOfflineShow3DModelView

#define kA3DWebOfflineShow3DModelView   0x000002

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

◆ kA3DWebOfflineShowViewNavigation

#define kA3DWebOfflineShowViewNavigation   0x000004

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

◆ kA3DWebOfflineDefaultOptions

#define kA3DWebOfflineDefaultOptions   (kA3DWebOfflineShow3DToolbar | kA3DWebOfflineShow3DModelView)

Default options set when initializing the flags.

◆ kA3DPDFUnknownStreamIdentifier

#define kA3DPDFUnknownStreamIdentifier   0

Special identifier value for A3DStream3DPDFData.

Version
1