com.itextpdf.kernel.pdf.colorspace

Class PdfShading.CoonsPatchMesh

java.lang.Object

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

com.itextpdf.kernel.pdf.colorspace.PdfShading

com.itextpdf.kernel.pdf.colorspace.PdfShading.CoonsPatchMesh

All Implemented Interfaces:

Serializable

Enclosing class:

PdfShading

public static class PdfShading.CoonsPatchMesh
extends PdfShading

The class that extends PdfShading class and is in charge of Shading Dictionary with Coons Patch mesh type. This type of shading is constructed from one or more colour patches, each bounded by four cubic Bézier curves. Degenerate Bézier curves are allowed and are useful for certain graphical effects. At least one complete patch shall be specified. The shape of patch is defined by 12 control points. Colours are specified for each corner of the unit square, and bilinear interpolation is used to fill in colours over the entire unit square. Coordinates are mapped from the unit square into a four-sided patch whose sides are not necessarily linear. The mapping is continuous: the corners of the unit square map to corners of the patch and the sides of the unit square map to sides of the patch. For the format of data stream, that defines patches (see ISO-320001 Table 85). If the shading dictionary contains a Function entry, the colour data for each corner of a patch shall be specified by a single parametric value t rather than by n separate 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
CoonsPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, float[] decode) Creates the new instance of the class.
CoonsPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, PdfArray decode) Creates the new instance of the class.
CoonsPatchMesh(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

CoonsPatchMesh

public CoonsPatchMesh(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.

CoonsPatchMesh

public CoonsPatchMesh(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, 2 or 3.

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.

CoonsPatchMesh

public CoonsPatchMesh(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, 2 or 3.

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, 2 or 3.

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, 2 or 3.

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.