Table of Contents

Class Pdf3DAnnotation

Namespace
iText.Kernel.Pdf.Annot
Assembly
itext.kernel.dll

This class represents 3D annotations by which 3D artwork shall be represented in a PDF document.

public class Pdf3DAnnotation : PdfAnnotation
Inheritance
Pdf3DAnnotation
Inherited Members

Remarks

This class represents 3D annotations by which 3D artwork shall be represented in a PDF document. See also ISO-32000-2 13.6.2 "3D annotations".

Constructors

Pdf3DAnnotation(Rectangle, PdfObject)

Creates a Pdf3DAnnotation instance.

public Pdf3DAnnotation(Rectangle rect, PdfObject artwork)

Parameters

rect Rectangle

the annotation rectangle, defining the location of the annotation on the page in default user space units. See SetRectangle(PdfArray).

artwork PdfObject

3D artwork which is represented by the annotation

Pdf3DAnnotation(PdfDictionary)

Instantiates a new Pdf3DAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

public Pdf3DAnnotation(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

the PdfDictionary representing annotation object

See Also

Methods

GetActivationDictionary()

Gets the activation dictionary that defines the times at which the annotation shall be activated and deactivated and the state of the 3D artwork instance at those times.

public virtual PdfDictionary GetActivationDictionary()

Returns

PdfDictionary

the activation dictionary that defines the times at which the annotation shall be activated and deactivated and the state of the 3D artwork instance at those times.

GetDefaultInitialView()

Gets the default initial view of the 3D artwork that shall be used when the annotation is activated.

public virtual PdfObject GetDefaultInitialView()

Returns

PdfObject

the default initial view of the 3D artwork that shall be used when the annotation is activated

GetSubtype() 

public override PdfName GetSubtype()

Returns

PdfName

GetViewBox()

Gets the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn.

public virtual Rectangle GetViewBox()

Returns

Rectangle

the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn.

IsInteractive()

Indicates whether the 3D annotation is intended to be interactive or not.

public virtual PdfBoolean IsInteractive()

Returns

PdfBoolean

whether the 3D annotation is intended to be interactive or not

SetActivationDictionary(PdfDictionary)

Sets the activation dictionary that defines the times at which the annotation shall be activated and deactivated and the state of the 3D artwork instance at those times.

public virtual Pdf3DAnnotation SetActivationDictionary(PdfDictionary activationDictionary)

Parameters

activationDictionary PdfDictionary

dictionary that defines the times at which the annotation shall be activated and deactivated and the state of the 3D artwork instance at those times.

Returns

Pdf3DAnnotation

this Pdf3DAnnotation instance

SetDefaultInitialView(PdfObject)

Sets the default initial view of the 3D artwork that shall be used when the annotation is activated.

public virtual Pdf3DAnnotation SetDefaultInitialView(PdfObject initialView)

Parameters

initialView PdfObject

the default initial view of the 3D artwork that shall be used when the annotation is activated

Returns

Pdf3DAnnotation

this Pdf3DAnnotation instance

SetInteractive(bool)

Sets the primary use of the 3D annotation.

public virtual Pdf3DAnnotation SetInteractive(bool interactive)

Parameters

interactive bool

if true, it is intended to be interactive; if false, it is intended to be manipulated programmatically

Returns

Pdf3DAnnotation

this Pdf3DAnnotation instance

Remarks

Sets the primary use of the 3D annotation.

If true, it is intended to be interactive; if false, it is intended to be manipulated programmatically, as with an ECMAScript animation. Interactive PDF processors may present different user interface controls for interactive 3D annotations (for example, to rotate, pan, or zoom the artwork) than for those managed by a script or other mechanism.

Default value: true.

SetViewBox(Rectangle)

Sets the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn.

public virtual Pdf3DAnnotation SetViewBox(Rectangle viewBox)

Parameters

viewBox Rectangle

the rectangular area in which the 3D artwork shall be drawn

Returns

Pdf3DAnnotation

this Pdf3DAnnotation instance

Remarks

Sets the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn. It shall be within the rectangle specified by the annotation’s Rect entry and shall be expressed in the annotation’s target coordinate system.

Default value: the annotation’s Rect entry, expressed in the target coordinate system. This value is [-w/2 -h/2 w/2 h/2], where w and h are the width and height, respectively, of Rect.