Class Pdf3DAnnotation


  • public class Pdf3DAnnotation
    extends PdfAnnotation
    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".
    • Method Detail

      • getSubtype

        public PdfName getSubtype()
        Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.
        Specified by:
        getSubtype in class PdfAnnotation
        Returns:
        subtype of this annotation.
      • setDefaultInitialView

        public Pdf3DAnnotation setDefaultInitialView​(PdfObject initialView)
        Sets the default initial view of the 3D artwork that shall be used when the annotation is activated.
        Parameters:
        initialView - the default initial view of the 3D artwork that shall be used when the annotation is activated
        Returns:
        this Pdf3DAnnotation instance
      • getDefaultInitialView

        public PdfObject getDefaultInitialView()
        Gets the default initial view of the 3D artwork that shall be used when the annotation is activated.
        Returns:
        the default initial view of the 3D artwork that shall be used when the annotation is activated
      • setActivationDictionary

        public Pdf3DAnnotation setActivationDictionary​(PdfDictionary activationDictionary)
        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.
        Parameters:
        activationDictionary - 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:
        this Pdf3DAnnotation instance
      • getActivationDictionary

        public PdfDictionary 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.
        Returns:
        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.
      • setInteractive

        public Pdf3DAnnotation setInteractive​(boolean interactive)
        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.

        Parameters:
        interactive - if true, it is intended to be interactive; if false, it is intended to be manipulated programmatically
        Returns:
        this Pdf3DAnnotation instance
      • isInteractive

        public PdfBoolean isInteractive()
        Indicates whether the 3D annotation is intended to be interactive or not.
        Returns:
        whether the 3D annotation is intended to be interactive or not
      • setViewBox

        public Pdf3DAnnotation setViewBox​(Rectangle viewBox)
        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.

        Parameters:
        viewBox - the rectangular area in which the 3D artwork shall be drawn
        Returns:
        this Pdf3DAnnotation instance
      • getViewBox

        public Rectangle getViewBox()
        Gets the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn.
        Returns:
        the 3D view box, which is the rectangular area in which the 3D artwork shall be drawn.