Package com.tom_roush.pdfbox.pdmodel.graphics.shading

Class PDShadingType4

java.lang.Object

com.tom_roush.pdfbox.pdmodel.graphics.shading.PDShading

com.tom_roush.pdfbox.pdmodel.graphics.shading.PDShadingType4

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDShadingType6, PDShadingType7

public class PDShadingType4
extends PDShading

Resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Mesh).

Field Summary

Fields inherited from class com.tom_roush.pdfbox.pdmodel.graphics.shading.PDShading

SHADING_TYPE1, SHADING_TYPE2, SHADING_TYPE3, SHADING_TYPE4, SHADING_TYPE5, SHADING_TYPE6, SHADING_TYPE7

Constructor Summary

Constructors

Constructor	Description
PDShadingType4(COSDictionary shadingDictionary)	Constructor using the given shading dictionary.

Method Summary

Modifier and Type	Method	Description
int	getBitsPerComponent()	The bits per component of this shading.
int	getBitsPerCoordinate()	The bits per coordinate of this shading.
int	getBitsPerFlag()	The bits per flag of this shading.
RectF	getBounds(AffineTransform xform, Matrix matrix)	Calculate a bounding rectangle around the areas of this shading context.
PDRange	getDecodeForParameter(int paramNum)	Get the decode for the input parameter.
int	getNumberOfColorComponents()	The number of color components of this shading.
int	getShadingType()	This will return the shading type.
protected float	interpolate(float src, long srcMax, float dstMin, float dstMax)	Calculate the interpolation, see p.345 pdf spec 1.7.
protected com.tom_roush.pdfbox.pdmodel.graphics.shading.Vertex	readVertex(ImageInputStream input, long maxSrcCoord, long maxSrcColor, PDRange rangeX, PDRange rangeY, PDRange[] colRangeTab, Matrix matrix, AffineTransform xform)	Read a vertex from the bit input stream performs interpolations.
void	setBitsPerComponent(int bitsPerComponent)	Set the number of bits per component.
void	setBitsPerCoordinate(int bitsPerCoordinate)	Set the number of bits per coordinate.
void	setBitsPerFlag(int bitsPerFlag)	Set the number of bits per flag.
void	setDecodeValues(COSArray decodeValues)	This will set the decode values.

Methods inherited from class com.tom_roush.pdfbox.pdmodel.graphics.shading.PDShading

create, evalFunction, evalFunction, getAntiAlias, getBackground, getBBox, getColorSpace, getCOSObject, getFunction, getType, setAntiAlias, setBackground, setBBox, setColorSpace, setFunction, setFunction, setShadingType

Methods inherited from class java.lang.Object

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

Constructor Detail

PDShadingType4

public PDShadingType4(COSDictionary shadingDictionary)

Constructor using the given shading dictionary.

Parameters:

shadingDictionary - the dictionary for this shading

Method Detail

getShadingType

public int getShadingType()

Description copied from class: PDShading

This will return the shading type.

Specified by:

getShadingType in class PDShading

Returns:

the shading typ

getBitsPerFlag

public int getBitsPerFlag()

The bits per flag of this shading. This will return -1 if one has not been set.

Returns:

The number of bits per flag.

setBitsPerFlag

public void setBitsPerFlag(int bitsPerFlag)

Set the number of bits per flag.

Parameters:

bitsPerFlag - the number of bits per flag

getBitsPerComponent

public int getBitsPerComponent()

The bits per component of this shading. This will return -1 if one has not been set.

Returns:

the number of bits per component

setBitsPerComponent

public void setBitsPerComponent(int bitsPerComponent)

Set the number of bits per component.

Parameters:

bitsPerComponent - the number of bits per component

getBitsPerCoordinate

public int getBitsPerCoordinate()

The bits per coordinate of this shading. This will return -1 if one has not been set.

Returns:

the number of bits per coordinate

setBitsPerCoordinate

public void setBitsPerCoordinate(int bitsPerCoordinate)

Set the number of bits per coordinate.

Parameters:

bitsPerCoordinate - the number of bits per coordinate

getNumberOfColorComponents

public int getNumberOfColorComponents()
                               throws IOException

The number of color components of this shading.

Returns:

number of color components of this shading

Throws:

IOException

setDecodeValues

public void setDecodeValues(COSArray decodeValues)

This will set the decode values.

Parameters:

decodeValues - the new decode values

getDecodeForParameter

public PDRange getDecodeForParameter(int paramNum)

Get the decode for the input parameter.

Parameters:

paramNum - the function parameter number

Returns:

the decode parameter range or null if none is set

interpolate

protected float interpolate(float src,
                            long srcMax,
                            float dstMin,
                            float dstMax)

Calculate the interpolation, see p.345 pdf spec 1.7.

Parameters:

src - src value

srcMax - max src value (2^bits-1)

dstMin - min dst value

dstMax - max dst value

Returns:

interpolated value

readVertex

protected com.tom_roush.pdfbox.pdmodel.graphics.shading.Vertex readVertex(ImageInputStream input,
                                                                          long maxSrcCoord,
                                                                          long maxSrcColor,
                                                                          PDRange rangeX,
                                                                          PDRange rangeY,
                                                                          PDRange[] colRangeTab,
                                                                          Matrix matrix,
                                                                          AffineTransform xform)
                                                                   throws IOException

Read a vertex from the bit input stream performs interpolations.

Parameters:

input - bit input stream

maxSrcCoord - max value for source coordinate (2^bits-1)

maxSrcColor - max value for source color (2^bits-1)

rangeX - dest range for X

rangeY - dest range for Y

colRangeTab - dest range array for colors

matrix - the pattern matrix concatenated with that of the parent content stream

Returns:

a new vertex with the flag and the interpolated values

Throws:

IOException - if something went wrong

getBounds

public RectF getBounds(AffineTransform xform,
                       Matrix matrix)
                throws IOException

Description copied from class: PDShading

Calculate a bounding rectangle around the areas of this shading context.

Overrides:

getBounds in class PDShading

Returns:

Bounding rectangle or null, if not supported by this shading type.

Throws:

IOException