com.itextpdf.kernel.pdf.colorspace

Class PdfShading.FreeFormGouraudShadedTriangleMesh

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.colorspace.PdfShading

com.itextpdf.kernel.pdf.colorspace.PdfShading.FreeFormGouraudShadedTriangleMesh

All Implemented Interfaces:

Serializable

Enclosing class:

PdfShading

public static class PdfShading.FreeFormGouraudShadedTriangleMesh
extends PdfShading

The class that extends PdfShading class and is in charge of Shading Dictionary with free-form Gouraud-shaded triangle mesh type. The area to be shaded is defined by a path composed entirely of triangles. The colour at each vertex of the triangles is specified, and a technique known as Gouraud interpolation is used to colour the interiors. The object shall be represented as stream containing a sequence of vertex data. Each vertex is specified by the following values, in the order shown: f x y c1 ... cn where: f - the vertex's edge flag, that determines the vertex is connected to other vertices of the triangle mesh. For full description, see ISO-320001 Paragraph 8.7.4.5.5 x, y - vertex's horizontal and vertical coordinates, expressed in the shading's target coordinate space. c1...cn - vertex's colour components. If the shading dictionary includes a Function entry, only a single parametric value, t, shall be specified for each vertex in place of the colour components c1...cn.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.colorspace.PdfShading

PdfShading.Axial, PdfShading.CoonsPatchMesh, PdfShading.FreeFormGouraudShadedTriangleMesh, PdfShading.FunctionBased, PdfShading.LatticeFormGouraudShadedTriangleMesh, PdfShading.Radial, PdfShading.TensorProductPatchMesh

Constructor Summary

Constructors

Constructor and Description
FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, float[] decode) Creates the new instance of the class.
FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, PdfArray decode) Creates the new instance of the class.
FreeFormGouraudShadedTriangleMesh(PdfStream pdfStream) Deprecated. Intended only for private use. You should use PdfShading.makeShading(PdfDictionary) instead.

Method Summary

Modifier and Type	Method and Description
int	getBitsPerComponent() Gets the number of bits used to represent each colour component.
int	getBitsPerCoordinate() Gets the number of bits used to represent each vertex coordinate.
int	getBitsPerFlag() Gets the number of bits used to represent the edge flag for each vertex.
PdfArray	getDecode() Gets the PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.
void	setBitsPerComponent(int bitsPerComponent) Sets the number of bits used to represent each colour component.
void	setBitsPerCoordinate(int bitsPerCoordinate) Sets the number of bits used to represent each vertex coordinate.
void	setBitsPerFlag(int bitsPerFlag) Sets the number of bits used to represent the edge flag for each vertex.
void	setDecode(float[] decode) Sets the float[] of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.
void	setDecode(PdfArray decode) Sets the PdfArray of numbers specifying how to map vertex coordinates and colour components into the appropriate ranges of values.

Methods inherited from class com.itextpdf.kernel.pdf.colorspace.PdfShading

flush, getColorSpace, getFunction, getShadingType, isWrappedObjectMustBeIndirect, makeShading, setFunction, setFunction

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreeFormGouraudShadedTriangleMesh

public FreeFormGouraudShadedTriangleMesh(PdfStream pdfStream)

Deprecated. Intended only for private use. You should use PdfShading.makeShading(PdfDictionary) instead.

Creates the new instance of the class from the existing PdfStream object.

Parameters:

pdfStream - PdfStream from which the instance is created.

FreeFormGouraudShadedTriangleMesh

public FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs,
                                         int bitsPerCoordinate,
                                         int bitsPerComponent,
                                         int bitsPerFlag,
                                         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.

bitsPerFlag - the number of bits used to represent the edge flag for each vertex. The value of BitsPerFlag shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. The value for the edge flag shall be 0, 1, or 2.

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.

FreeFormGouraudShadedTriangleMesh

public FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs,
                                         int bitsPerCoordinate,
                                         int bitsPerComponent,
                                         int bitsPerFlag,
                                         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.

bitsPerFlag - the number of bits used to represent the edge flag for each vertex. The value of BitsPerFlag shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. The value for the edge flag shall be 0, 1, or 2.

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 Detail

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.

getBitsPerFlag

public int getBitsPerFlag()

Gets the number of bits used to represent the edge flag for each vertex. But only the least significant 2 bits in each flag value shall be used. The valid flag values are 0, 1 or 2.

Returns:

the number of bits. Can be 2, 4 or 8.

setBitsPerFlag

public void setBitsPerFlag(int bitsPerFlag)

Sets the number of bits used to represent the edge flag for each vertex. But only the least significant 2 bits in each flag value shall be used. The valid flag values are 0, 1 or 2.

Parameters:

bitsPerFlag - the number of bits to be set. Shall be 2, 4 or 8.

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.