Class PDShadingResources
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDShadingType1
,PDShadingType2
,PDShadingType4
,PDShadingType5
public abstract class PDShadingResources extends java.lang.Object implements COSObjectable
This represents resources for a shading.- Version:
- $Revision: 1.0 $
-
-
Field Summary
Fields Modifier and Type Field Description static int
SHADING_TYPE1
shading type 1 = function based shading.static int
SHADING_TYPE2
shading type 2 = axial shading.static int
SHADING_TYPE3
shading type 3 = radial shading.static int
SHADING_TYPE4
shading type 4 = Free-Form Gouraud-Shaded Triangle Meshes.static int
SHADING_TYPE5
shading type 5 = Lattice-Form Gouraud-Shaded Triangle Meshes.static int
SHADING_TYPE6
shading type 6 = Coons Patch Meshes.static int
SHADING_TYPE7
shading type 7 = Tensor-Product Patch Meshes.
-
Constructor Summary
Constructors Constructor Description PDShadingResources()
Default constructor.PDShadingResources(COSDictionary shadingDictionary)
Constructor using the given shading dictionary.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static PDShadingResources
create(COSDictionary resourceDictionary)
Create the correct PD Model shading based on the COS base shading.float[]
evalFunction(float inputValue)
Convert the input value using the functions of the shading dictionary.float[]
evalFunction(float[] input)
Convert the input values using the functions of the shading dictionary.boolean
getAntiAlias()
This will return the AntiAlias value.COSArray
getBackground()
This will return the background.PDRectangle
getBBox()
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the shadings's bounding box.PDColorSpace
getColorSpace()
This will get the color space or null if none exists.COSDictionary
getCOSDictionary()
This will get the underlying dictionary.COSBase
getCOSObject()
Convert this standard java object to a COS object.PDFunction
getFunction()
This will return the function used to convert the color values.abstract int
getShadingType()
This will return the shading type.java.lang.String
getType()
This will return the type.void
setAntiAlias(boolean antiAlias)
This will set the AntiAlias value.void
setBackground(COSArray newBackground)
This will set the background.void
setBBox(PDRectangle newBBox)
This will set the BBox (bounding box) for this Shading.void
setColorSpace(PDColorSpace newColorspace)
This will set the color space for the shading.void
setFunction(COSArray newFunctions)
This will set the functions COSArray for the color conversion.void
setFunction(PDFunction newFunction)
This will set the function for the color conversion.void
setShadingType(int shadingType)
This will set the shading type.
-
-
-
Field Detail
-
SHADING_TYPE1
public static final int SHADING_TYPE1
shading type 1 = function based shading.- See Also:
- Constant Field Values
-
SHADING_TYPE2
public static final int SHADING_TYPE2
shading type 2 = axial shading.- See Also:
- Constant Field Values
-
SHADING_TYPE3
public static final int SHADING_TYPE3
shading type 3 = radial shading.- See Also:
- Constant Field Values
-
SHADING_TYPE4
public static final int SHADING_TYPE4
shading type 4 = Free-Form Gouraud-Shaded Triangle Meshes.- See Also:
- Constant Field Values
-
SHADING_TYPE5
public static final int SHADING_TYPE5
shading type 5 = Lattice-Form Gouraud-Shaded Triangle Meshes.- See Also:
- Constant Field Values
-
SHADING_TYPE6
public static final int SHADING_TYPE6
shading type 6 = Coons Patch Meshes.- See Also:
- Constant Field Values
-
SHADING_TYPE7
public static final int SHADING_TYPE7
shading type 7 = Tensor-Product Patch Meshes.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDShadingResources
public PDShadingResources()
Default constructor.
-
PDShadingResources
public PDShadingResources(COSDictionary shadingDictionary)
Constructor using the given shading dictionary.- Parameters:
shadingDictionary
- The dictionary for this shading.
-
-
Method Detail
-
getCOSDictionary
public COSDictionary getCOSDictionary()
This will get the underlying dictionary.- Returns:
- The dictionary for this shading.
-
getCOSObject
public COSBase getCOSObject()
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getType
public java.lang.String getType()
This will return the type.- Returns:
- The type of object that this is.
-
setShadingType
public void setShadingType(int shadingType)
This will set the shading type.- Parameters:
shadingType
- The new shading type.
-
getShadingType
public abstract int getShadingType()
This will return the shading type.- Returns:
- The shading type
-
setBackground
public void setBackground(COSArray newBackground)
This will set the background.- Parameters:
newBackground
- The new background.
-
getBackground
public COSArray getBackground()
This will return the background.- Returns:
- The background
-
getBBox
public PDRectangle getBBox()
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the shadings's bounding box.- Returns:
- The BBox of the form.
-
setBBox
public void setBBox(PDRectangle newBBox)
This will set the BBox (bounding box) for this Shading.- Parameters:
newBBox
- The new BBox.
-
setAntiAlias
public void setAntiAlias(boolean antiAlias)
This will set the AntiAlias value.- Parameters:
antiAlias
- The new AntiAlias value.
-
getAntiAlias
public boolean getAntiAlias()
This will return the AntiAlias value.- Returns:
- The AntiAlias value
-
getColorSpace
public PDColorSpace getColorSpace() throws java.io.IOException
This will get the color space or null if none exists.- Returns:
- The color space for the shading.
- Throws:
java.io.IOException
- If there is an error getting the colorspace.
-
setColorSpace
public void setColorSpace(PDColorSpace newColorspace)
This will set the color space for the shading.- Parameters:
newColorspace
- The color space
-
create
public static PDShadingResources create(COSDictionary resourceDictionary) throws java.io.IOException
Create the correct PD Model shading based on the COS base shading.- Parameters:
resourceDictionary
- the COS shading dictionary- Returns:
- the newly created shading resources object
- Throws:
java.io.IOException
- If we are unable to create the PDShading object.
-
setFunction
public void setFunction(PDFunction newFunction)
This will set the function for the color conversion.- Parameters:
newFunction
- The new function.
-
setFunction
public void setFunction(COSArray newFunctions)
This will set the functions COSArray for the color conversion.- Parameters:
newFunctions
- The new COSArray containing all functions.
-
getFunction
public PDFunction getFunction() throws java.io.IOException
This will return the function used to convert the color values.- Returns:
- The function
- Throws:
java.io.IOException
- If we are unable to create the PDFunction object.
-
evalFunction
public float[] evalFunction(float inputValue) throws java.io.IOException
Convert the input value using the functions of the shading dictionary.- Parameters:
inputValue
- the input value- Returns:
- the output values
- Throws:
java.io.IOException
- thrown if something went wrong
-
evalFunction
public float[] evalFunction(float[] input) throws java.io.IOException
Convert the input values using the functions of the shading dictionary.- Parameters:
input
- the input values- Returns:
- the output values
- Throws:
java.io.IOException
- thrown if something went wrong
-
-