Class PdfShading.LatticeFormGouraudShadedTriangleMesh

java.lang.Object
com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
com.itextpdf.kernel.pdf.colorspace.PdfShading
com.itextpdf.kernel.pdf.colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh
Enclosing class:
PdfShading

public static class PdfShading.LatticeFormGouraudShadedTriangleMesh extends PdfShading
The class that extends PdfShading class and is in charge of Shading Dictionary with lattice-form Gouraud-shaded triangle mesh type. This type is similar to PdfShading.FreeFormGouraudShadedTriangleMesh but instead of using free-form geometry, the vertices are arranged in a pseudorectangular lattice, which is topologically equivalent to a rectangular grid. The vertices are organized into rows, which need not be geometrically linear. The verticals data in stream is similar to PdfShading.FreeFormGouraudShadedTriangleMesh, except there is no edge flag.
  • Constructor Details

    • LatticeFormGouraudShadedTriangleMesh

      protected LatticeFormGouraudShadedTriangleMesh (PdfStream pdfStream)
      Creates the new instance of the class from the existing PdfStream.
      Parameters:
      pdfStream - from which this PdfShading.LatticeFormGouraudShadedTriangleMesh will be created
    • LatticeFormGouraudShadedTriangleMesh

      public LatticeFormGouraudShadedTriangleMesh (PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int verticesPerRow, float[] decode)
      Creates the new instance of the class.
      Parameters:
      cs - the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
      bitsPerCoordinate - the number of bits used to represent each vertex coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
      bitsPerComponent - the number of bits used to represent each colour component. The value shall be 1, 2, 4, 8, 12, or 16.
      verticesPerRow - the number of vertices in each row of the lattice (shall be > 1). The number of rows need not be specified.
      decode - the int[] of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. The ranges shall be specified as follows: [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max]. Only one pair of color values shall be specified if a Function entry is present.
    • LatticeFormGouraudShadedTriangleMesh

      public LatticeFormGouraudShadedTriangleMesh (PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int verticesPerRow, PdfArray decode)
      Creates the new instance of the class.
      Parameters:
      cs - the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
      bitsPerCoordinate - the number of bits used to represent each vertex coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
      bitsPerComponent - the number of bits used to represent each colour component. The value shall be 1, 2, 4, 8, 12, or 16.
      verticesPerRow - the number of vertices in each row of the lattice (shall be > 1). The number of rows need not be specified.
      decode - the PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. The ranges shall be specified as follows: [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max]. Only one pair of color values shall be specified if a Function entry is present.
  • Method Details

    • getBitsPerCoordinate

      public int getBitsPerCoordinate()
      Gets the number of bits used to represent each vertex coordinate.
      Returns:
      the number of bits. Can be 1, 2, 4, 8, 12, 16, 24, or 32.
    • setBitsPerCoordinate

      public void setBitsPerCoordinate (int bitsPerCoordinate)
      Sets the number of bits used to represent each vertex coordinate.
      Parameters:
      bitsPerCoordinate - the number of bits to be set. Shall be 1, 2, 4, 8, 12, 16, 24, or 32.
    • getBitsPerComponent

      public int getBitsPerComponent()
      Gets the number of bits used to represent each colour component.
      Returns:
      the number of bits. Can be 1, 2, 4, 8, 12, or 16.
    • setBitsPerComponent

      public void setBitsPerComponent (int bitsPerComponent)
      Sets the number of bits used to represent each colour component.
      Parameters:
      bitsPerComponent - the number of bits to be set. Shall be 1, 2, 4, 8, 12, or 16.
    • getVerticesPerRow

      public int getVerticesPerRow()
      Gets the number of vertices in each row of the lattice.
      Returns:
      the number of vertices. Can only be greater than 1.
    • setVerticesPerRow

      public void setVerticesPerRow (int verticesPerRow)
      Sets the number of vertices in each row of the lattice. The number of rows need not be specified.
      Parameters:
      verticesPerRow - the number of vertices to be set. Shall be greater than 1.
    • getDecode

      public PdfArray getDecode()
      Gets the PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. The ranges shall be specified as follows: [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max]. Only one pair of color values shall be specified if a Function entry is present.
      Returns:
      the PdfArray Decode object.
    • setDecode

      public void setDecode (float[] decode)
      Sets the float[] of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. The ranges shall be specified as follows: [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max]. Only one pair of color values shall be specified if a Function entry is present.
      Parameters:
      decode - the float[] of Decode object to set.
    • setDecode

      public void setDecode (PdfArray decode)
      Sets the PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. The ranges shall be specified as follows: [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max]. Only one pair of color values shall be specified if a Function entry is present.
      Parameters:
      decode - the PdfArray Decode object to set.