org.apache.pdfbox.pdmodel.graphics.shading
Class PDShadingType5

java.lang.Object
  org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
      org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5

All Implemented Interfaces:

COSObjectable

public class PDShadingType5
extends PDShadingResources

This represents resources for a shading type 5 (Lattice-Form Gouraud-Shaded Triangle Meshes).

Version:

$Revision: 1.0 $

Field Summary

Fields inherited from class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources

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

Constructor Summary

PDShadingType5(COSDictionary shadingDictionary)
Constructor using the given shading dictionary.

Method Summary

int	getBitsPerComponent() The bits per component of this shading.
int	getBitsPerCoordinate() The bits per coordinate of this shading.
PDRange	getDecodeForParameter(int paramNum) Get the decode for the input parameter.
PDFunction	getFunction() This will return the function used to convert the color values.
int	getShadingType() This will return the shading type.
int	getVerticesPerRow() The vertices per row of this shading.
void	setBitsPerComponent(int bpc) Set the number of bits per component.
void	setBitsPerCoordinate(int bpc) Set the number of bits per coordinate.
void	setDecodeValues(COSArray decodeValues) This will set the decode values.
void	setFunction(PDFunction newFunction) This will set the function for the color conversion.
void	setVerticesPerRow(int vpr) Set the number of vertices per row.

Methods inherited from class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources

create, getAntiAlias, getBackground, getBBox, getColorSpace, getCOSDictionary, getCOSObject, getType, setAntiAlias, setBackground, setBBox, setColorSpace, setShadingType

Methods inherited from class java.lang.Object

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

Constructor Detail

PDShadingType5

public PDShadingType5(COSDictionary shadingDictionary)

Constructor using the given shading dictionary.

Parameters:

shadingDictionary - The dictionary for this shading.

Method Detail

getShadingType

public int getShadingType()

This will return the shading type.

Specified by:

getShadingType in class PDShadingResources

Returns:

The shading type

setFunction

public void setFunction(PDFunction newFunction)

This will set the function for the color conversion.

Parameters:

newFunction - The new function.

getFunction

public PDFunction getFunction()
                       throws IOException

This will return the function used to convert the color values.

Returns:

The function

Throws:

IOException - If we are unable to create the PDFunction object.

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 bpc)

Set the number of bits per component.

Parameters:

bpc - 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 bpc)

Set the number of bits per coordinate.

Parameters:

bpc - The number of bits per coordinate.

getVerticesPerRow

public int getVerticesPerRow()

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

Returns:

The number of vertices per row.

setVerticesPerRow

public void setVerticesPerRow(int vpr)

Set the number of vertices per row.

Parameters:

vpr - The number of vertices per row.

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.