com.alkacon.simapi

Class RenderSettings

java.lang.Object

com.alkacon.simapi.RenderSettings

public class RenderSettings
extends java.lang.Object

Provides rendering hints of different quality for the image processing.

Author:

Alexander Kandzior

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.awt.RenderingHints	HINTS_MEDIUM Rendering hints for the default MEDIUM render settigns.
protected static java.awt.RenderingHints	HINTS_QUALITY Rendering hints for the default QUALITY render settigns.
protected static java.awt.RenderingHints	HINTS_SPEED Rendering hints for the default SPEED render settigns.

Constructor Summary

Constructors

Constructor and Description
RenderSettings(int baseMode) Create a new set of render settings, based on the given constant base mode.
RenderSettings(int baseMode, java.awt.RenderingHints hints) Create a new set of render settings, based on the given constant base mode and the provided special rendering hints.

Method Summary

Methods

Modifier and Type	Method and Description
void	addImageFilter(java.awt.image.ImageFilter filter) Adds a new image filter to the filter processing list.
float	getCompressionQuality() Returns the image save compression quality, used for JPEG images (and other formats that support such a setting).
java.util.List<java.awt.image.ImageFilter>	getImageFilters() Returns a copy of the list of image filters that should be applied to the processed image.
int	getMaximumBlurSize() Returns the maximum size of an image that is blurred before applying a downscaling operation.
protected java.awt.RenderingHints	getRenderingHints() Returns the image rendering hints to to be used for image scaling etc.
protected int	getThreadNicePriority() Returns the thread priority to use for image operations that require a lot of CPU power.
protected int	getThreadOldPriority() Returns the stored thread priority used.
java.awt.Color	getTransparentReplaceColor() Returns the backgound color replacement for the transparent color.
boolean	isUseBlur() Returns true if blur is used when downscaling an image to a thumbnail.
void	setCompressionQuality(float compressionQuality) Sets the image save compression quality, used for JPEG images (and other formats that support such a setting).
void	setMaximumBlurSize(int maximumBlurSize) Sets the maximum size of an image that is blurred before applying a downscaling operation.
protected void	setThreadNicePriority(int threadNicePriority) Sets the thread priority to use for image operations that require a lot of CPU power.
protected void	setThreadOldPriority(int threadOldPriority) Sets the stored thread priority.
void	setTransparentReplaceColor(java.awt.Color transparentColor) Sets the backgound color replacement for the transparent color.

Methods inherited from class java.lang.Object

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

Field Detail

HINTS_MEDIUM

protected static final java.awt.RenderingHints HINTS_MEDIUM

Rendering hints for the default MEDIUM render settigns.

HINTS_QUALITY

protected static final java.awt.RenderingHints HINTS_QUALITY

Rendering hints for the default QUALITY render settigns.

HINTS_SPEED

protected static final java.awt.RenderingHints HINTS_SPEED

Rendering hints for the default SPEED render settigns.

Constructor Detail

RenderSettings

public RenderSettings(int baseMode)

Create a new set of render settings, based on the given constant base mode.

Parameters:

baseMode - the base mode of the settings, for example Simapi.RENDER_QUALITY

RenderSettings

public RenderSettings(int baseMode,
              java.awt.RenderingHints hints)

Create a new set of render settings, based on the given constant base mode and the provided special rendering hints.

Parameters:

baseMode - the base mode of the settings, for example Simapi.RENDER_QUALITY

hints - the special rendering hints to use for image processing operations like scaling etc.

Method Detail

addImageFilter

public void addImageFilter(java.awt.image.ImageFilter filter)

Adds a new image filter to the filter processing list.

Parameters:

filter - the image filter to add

getCompressionQuality

public float getCompressionQuality()

Returns the image save compression quality, used for JPEG images (and other formats that support such a setting).

This is used only if the image type supports different qualities. For example, this it is used when writing JPEG images. A quality of 0.1 is very poor, 0.75 is ok, 1.0 is maximum.

Returns:

the image save quality, used for JPEG images (and other formats that support such a setting)

getImageFilters

public java.util.List<java.awt.image.ImageFilter> getImageFilters()

Returns a copy of the list of image filters that should be applied to the processed image.

Returns:

a copy of the list of image filters that should be applied to the processed image

getMaximumBlurSize

public int getMaximumBlurSize()

Returns the maximum size of an image that is blurred before applying a downscaling operation.

If the image size is to big, "out of memory" errors may occur. The default is 2500 x 2500 pixel.

Returns:

the maximum size of an image that is blurred before apply a downscaling operation

getTransparentReplaceColor

public java.awt.Color getTransparentReplaceColor()

Returns the backgound color replacement for the transparent color.

This is used if transparency is not supported by the selected image format.

The default color is Color.WHITE.

Returns:

the backgound color replacement for the transparent color

isUseBlur

public boolean isUseBlur()

Returns true if blur is used when downscaling an image to a thumbnail.

This improves the thumbnail quality, but uses a lot more CPU and memory resources.

Returns:

true if blur is used when downscaling an image to a thumbnail

setCompressionQuality

public void setCompressionQuality(float compressionQuality)

Sets the image save compression quality, used for JPEG images (and other formats that support such a setting).

This is used only if the image type supports different qualities. For example, this it is used when writing JPEG images. A quality of 0.1 is very poor, 0.75 is ok, 1.0 is maximum.

Parameters:

compressionQuality - the compression quality to set (must be between 0 and 1)

setMaximumBlurSize

public void setMaximumBlurSize(int maximumBlurSize)

Sets the maximum size of an image that is blurred before applying a downscaling operation.

Parameters:

maximumBlurSize - the maximum size of an image to set

setTransparentReplaceColor

public void setTransparentReplaceColor(java.awt.Color transparentColor)

Sets the backgound color replacement for the transparent color.

This is used if transparency is not supported by the selected image format.

Parameters:

transparentColor - the backgound color replacement for the transparent color to set

getRenderingHints

protected java.awt.RenderingHints getRenderingHints()

Returns the image rendering hints to to be used for image scaling etc.

This method is protected to avoid changes to the constant values defined in this class.

Returns:

the image rendering hints to to be used for image scaling etc.

getThreadNicePriority

protected int getThreadNicePriority()

Returns the thread priority to use for image operations that require a lot of CPU power.

Returns:

the thread priority to use for image operations that require a lot of CPU power

getThreadOldPriority

protected int getThreadOldPriority()

Returns the stored thread priority used.

Returns:

the stored thread priority used

setThreadNicePriority

protected void setThreadNicePriority(int threadNicePriority)

Sets the thread priority to use for image operations that require a lot of CPU power.

Parameters:

threadNicePriority - the thread priority to set

setThreadOldPriority

protected void setThreadOldPriority(int threadOldPriority)

Sets the stored thread priority.

Parameters:

threadOldPriority - the thread priority to store