iText 8.0.2 API
iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh Class Reference

The class that extends PdfShading class and is in charge of Shading Dictionary with lattice-form Gouraud-shaded triangle mesh type. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh:
iText.Kernel.Pdf.Colorspace.PdfShading iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Member Functions

  LatticeFormGouraudShadedTriangleMesh (PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int verticesPerRow, float[] decode)
  Creates the new instance of the class. More...
 
  LatticeFormGouraudShadedTriangleMesh (PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int verticesPerRow, PdfArray decode)
  Creates the new instance of the class. More...
 
virtual int  GetBitsPerCoordinate ()
  Gets the number of bits used to represent each vertex coordinate. More...
 
virtual void  SetBitsPerCoordinate (int bitsPerCoordinate)
  Sets the number of bits used to represent each vertex coordinate. More...
 
virtual int  GetBitsPerComponent ()
  Gets the number of bits used to represent each colour component. More...
 
virtual void  SetBitsPerComponent (int bitsPerComponent)
  Sets the number of bits used to represent each colour component. More...
 
virtual int  GetVerticesPerRow ()
  Gets the number of vertices in each row of the lattice. More...
 
virtual void  SetVerticesPerRow (int verticesPerRow)
  Sets the number of vertices in each row of the lattice. More...
 
virtual PdfArray  GetDecode ()
  Gets the iText.Kernel.Pdf.PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. More...
 
virtual void  SetDecode (float[] decode)
  Sets the float[] of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. More...
 
virtual void  SetDecode (PdfArray decode)
  Sets the iText.Kernel.Pdf.PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
virtual int  GetShadingType ()
  Gets the shading type. More...
 
virtual PdfObject  GetColorSpace ()
  Gets the color space in which colour values shall be expressed. More...
 
virtual PdfObject  GetFunction ()
  Gets the function PdfObject that represents color transitions across the shading geometry. More...
 
virtual void  SetFunction (IPdfFunction function)
  Sets the function that represents color transitions across the shading geometry as one object. More...
 
virtual void  SetFunction (IPdfFunction[] functions)
  Sets the function object that represents color transitions across the shading geometry as an array of functions. More...
 
override void  Flush ()
  To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual bool  IsFlushed ()
 

Additional Inherited Members

- Static Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
static PdfShading  MakeShading (PdfDictionary shadingDictionary)
  Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary with corresponding type. More...
 

Detailed Description

The class that extends PdfShading class and is in charge of Shading Dictionary with lattice-form Gouraud-shaded triangle mesh type.

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 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 FreeFormGouraudShadedTriangleMesh , except there is no edge flag.

Constructor & Destructor Documentation

◆ LatticeFormGouraudShadedTriangleMesh() [1/2]

iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.LatticeFormGouraudShadedTriangleMesh ( PdfColorSpace  cs,
int  bitsPerCoordinate,
int  bitsPerComponent,
int  verticesPerRow,
float[]  decode 
)
inline

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() [2/2]

iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.LatticeFormGouraudShadedTriangleMesh ( PdfColorSpace  cs,
int  bitsPerCoordinate,
int  bitsPerComponent,
int  verticesPerRow,
PdfArray  decode 
)
inline

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 iText.Kernel.Pdf.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.

Member Function Documentation

◆ GetBitsPerComponent()

virtual int iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.GetBitsPerComponent ( )
inlinevirtual

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.

◆ GetBitsPerCoordinate()

virtual int iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.GetBitsPerCoordinate ( )
inlinevirtual

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.

◆ GetDecode()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.GetDecode ( )
inlinevirtual

Gets the iText.Kernel.Pdf.PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.

Gets the iText.Kernel.Pdf.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 iText.Kernel.Pdf.PdfArray Decode object.

◆ GetVerticesPerRow()

virtual int iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.GetVerticesPerRow ( )
inlinevirtual

Gets the number of vertices in each row of the lattice.

Returns
the number of vertices. Can only be greater than 1.

◆ SetBitsPerComponent()

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.SetBitsPerComponent ( int  bitsPerComponent )
inlinevirtual

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.

◆ SetBitsPerCoordinate()

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.SetBitsPerCoordinate ( int  bitsPerCoordinate )
inlinevirtual

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.

◆ SetDecode() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.SetDecode ( float[]  decode )
inlinevirtual

Sets the float[] of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.

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() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.SetDecode ( PdfArray  decode )
inlinevirtual

Sets the iText.Kernel.Pdf.PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.

Sets the iText.Kernel.Pdf.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 iText.Kernel.Pdf.PdfArray Decode object to set.

◆ SetVerticesPerRow()

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.LatticeFormGouraudShadedTriangleMesh.SetVerticesPerRow ( int  verticesPerRow )
inlinevirtual

Sets the number of vertices in each row of the lattice.

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.