/*
* Copyright 2014 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.pdmodel.graphics.shading;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.common.PDRange;
import org.apache.pdfbox.cos.COSDictionary;
/**
* Common resources for shading types 4,5,6 and 7
*/
abstract class PDTriangleBasedShadingType extends PDShading
{
// an array of 2^n numbers specifying the linear mapping of sample values
// into the range appropriate for the function's output values. Default
// value: same as the value of Range
private COSArray decode = null;
PDTriangleBasedShadingType(COSDictionary shadingDictionary)
{
super(shadingDictionary);
}
/**
* The bits per component of this shading. This will return -1 if one has
* not been set.
*
* @return the number of bits per component
*/
public int getBitsPerComponent()
{
return getCOSDictionary().getInt(COSName.BITS_PER_COMPONENT, -1);
}
/**
* Set the number of bits per component.
*
* @param bitsPerComponent the number of bits per component
*/
public void setBitsPerComponent(int bitsPerComponent)
{
getCOSDictionary().setInt(COSName.BITS_PER_COMPONENT, bitsPerComponent);
}
/**
* The bits per coordinate of this shading. This will return -1 if one has
* not been set.
*
* @return the number of bits per coordinate
*/
public int getBitsPerCoordinate()
{
return getCOSDictionary().getInt(COSName.BITS_PER_COORDINATE, -1);
}
/**
* Set the number of bits per coordinate.
*
* @param bitsPerComponent the number of bits per coordinate
*/
public void setBitsPerCoordinate(int bitsPerComponent)
{
getCOSDictionary().setInt(COSName.BITS_PER_COORDINATE, bitsPerComponent);
}
/**
* Returns all decode values as COSArray.
*
* @return the decode array
*/
private COSArray getDecodeValues()
{
if (decode == null)
{
decode = (COSArray) getCOSDictionary().getDictionaryObject(COSName.DECODE);
}
return decode;
}
/**
* This will set the decode values.
*
* @param decodeValues the new decode values
*/
public void setDecodeValues(COSArray decodeValues)
{
decode = decodeValues;
getCOSDictionary().setItem(COSName.DECODE, decodeValues);
}
/**
* Get the decode for the input parameter.
*
* @param paramNum the function parameter number
* @return the decode parameter range or null if none is set
*/
public PDRange getDecodeForParameter(int paramNum)
{
PDRange retval = null;
COSArray decodeValues = getDecodeValues();
if (decodeValues != null && decodeValues.size() >= paramNum * 2 + 1)
{
retval = new PDRange(decodeValues, paramNum);
}
return retval;
}
}