RenderSettings (Alkacon SimAPI)

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 `MEDIUM` render settings.
`protected static java.awt.RenderingHints`	`HINTS_QUALITY` Rendering hints for the default `QUALITY` render settings.
`protected static java.awt.RenderingHints`	`HINTS_QUALITY_BICUBIC` Rendering hints for the `HINTS_QUALITY_BICUBIC` render settings.
`protected static java.awt.RenderingHints`	`HINTS_QUALITY_SOFT` Rendering hints for the `HINTS_QUALITY_SOFT` render settings.
`protected static java.awt.RenderingHints`	`HINTS_SPEED` Rendering hints for the `SPEED` render settings.
`protected static int`	`MAX_BLUR_SIZE` Maximum height and width of an image to use blur filtering before scaling down.

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addImageFilter(java.awt.image.ImageFilter filter)` Adds a new image filter to the filter processing list.
`double`	`getBlurFactor()` Returns the base blur factor to use when scaling down.
`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 background 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.
`protected void`	`setUseBlur(boolean useBlur)` Controls if blur should be used at all.

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 MEDIUM render settings.
  - HINTS_QUALITY
```
protected static final java.awt.RenderingHints HINTS_QUALITY
```
    Rendering hints for the default QUALITY render settings.
  - HINTS_QUALITY_BICUBIC
```
protected static final java.awt.RenderingHints HINTS_QUALITY_BICUBIC
```
    Rendering hints for the HINTS_QUALITY_BICUBIC render settings.
  - HINTS_QUALITY_SOFT
```
protected static final java.awt.RenderingHints HINTS_QUALITY_SOFT
```
    Rendering hints for the HINTS_QUALITY_SOFT render settings.
  - HINTS_SPEED
```
protected static final java.awt.RenderingHints HINTS_SPEED
```
    Rendering hints for the SPEED render settings.
  - MAX_BLUR_SIZE
```
protected static final int MAX_BLUR_SIZE
```
    Maximum height and width of an image to use blur filtering before scaling down.
    Since the blur operation is quite expensive in memory, this should not be used for very large images. This sets the threshold.
    
    See Also:
    
    Constant Field Values
- 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
  - getBlurFactor
```
public double getBlurFactor()
```
    Returns the base blur factor to use when scaling down.
    
    Returns:
    
    the base blur factor to use when scaling down
  - 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 3000 x 3000 pixel.
    
    Returns:
    
    the maximum size of an image that is blurred before apply a downscaling operation
  - getTransparentReplaceColor
```
public java.awt.Color getTransparentReplaceColor()
```
    Returns the background 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 background 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
  - setUseBlur
```
protected void setUseBlur(boolean useBlur)
```
    Controls if blur should be used at all.
    
    Parameters:
    
    useBlur - if false, don't use blur

Class RenderSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HINTS_MEDIUM

HINTS_QUALITY

HINTS_QUALITY_BICUBIC

HINTS_QUALITY_SOFT

HINTS_SPEED

MAX_BLUR_SIZE

Constructor Detail

RenderSettings

RenderSettings

Method Detail

addImageFilter

getBlurFactor

getCompressionQuality

getImageFilters

getMaximumBlurSize

getTransparentReplaceColor

isUseBlur

setCompressionQuality

setMaximumBlurSize

setTransparentReplaceColor

getRenderingHints

getThreadNicePriority

getThreadOldPriority

setThreadNicePriority

setThreadOldPriority

setUseBlur