com.github.brunothg.game.engine.d2.commons

Class RenderingOptions

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<RenderingHints.Key,Object>

com.github.brunothg.game.engine.d2.commons.RenderingOptions

All Implemented Interfaces:

Serializable, Cloneable, Map<RenderingHints.Key,Object>

public class RenderingOptions
extends HashMap<RenderingHints.Key,Object>

A class holding several rendering settings, that can be used for configuring Graphics2D objects. Most methods can be used like a builder class.

Author:

Marvin Bruns

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RenderingOptions() No options set
RenderingOptions(Graphics g) Copies the options defined by the given Graphics object.

Method Summary

Modifier and Type	Method and Description
RenderingOptions	apply(Graphics g) Apply this rendering settings to an Graphics object.
RenderingOptions	apply(Graphics2D g, boolean fullyReplace) Apply this rendering settings to an Graphics2D object.
RenderingOptions	apply(Graphics g, boolean fullyReplace) Apply this rendering settings to an Graphics object.
void	copyOptionsFrom(Graphics g) Try to cast to Graphics2D and then copy its options
void	copyOptionsFrom(Graphics2D g) Copy options of the given Graphics2D object.
Object	put(RenderingHints.Key key, Object value) Set the rendering state for RenderingHints.Key.
void	putAll(Map<? extends RenderingHints.Key,? extends Object> m)
RenderingOptions	set(RenderingHints.Key key, Object value) Set the rendering option.
RenderingOptions	setAntiAliasing(Boolean on) Sets the anti aliasing option.
RenderingOptions	setAntiAliasingForText(Boolean on) Sets the anti aliasing option for text drawing.
RenderingOptions	setDithering(Boolean on) Sets the dithering option.
RenderingOptions	setEnhancedAlphaInterpolation(Boolean on) Sets the enhanced alpha interpolation option.
RenderingOptions	setEnhancedColorRednering(Boolean on) Sets the enhanced color rendering option.
RenderingOptions	setEnhancedInterpolation(Boolean on) Sets the enhanced interpolation option.
RenderingOptions	setEnhancedRednering(Boolean on) Sets the enhanced rendering option.
RenderingOptions	setFractionalMetrics(Boolean on) Sets the fractional metrics option.
RenderingOptions	setStrokeControl(Boolean on) Sets the stroke control option.
RenderingOptions	setTextLcdContrast(int contrast) Controls the LCD contrast level.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

RenderingOptions

public RenderingOptions()

No options set

RenderingOptions

public RenderingOptions(Graphics g)

Copies the options defined by the given Graphics object.

Parameters:

g - Graphics object used for initial configuration

Method Detail

copyOptionsFrom

public void copyOptionsFrom(Graphics g)

Try to cast to Graphics2D and then copy its options

Parameters:

g - Graphics2D used for copying

See Also:

copyOptionsFrom(Graphics2D)

copyOptionsFrom

public void copyOptionsFrom(Graphics2D g)

Copy options of the given Graphics2D object.

Parameters:

g - Graphics2D used for copying

putAll

public void putAll(Map<? extends RenderingHints.Key,? extends Object> m)

Specified by:

putAll in interface Map<RenderingHints.Key,Object>

Overrides:

putAll in class HashMap<RenderingHints.Key,Object>

put

public Object put(RenderingHints.Key key,
                  Object value)

Set the rendering state for RenderingHints.Key. Only values accepted by this RenderingHints.Key are allowed.

Specified by:

put in interface Map<RenderingHints.Key,Object>

Overrides:

put in class HashMap<RenderingHints.Key,Object>

Parameters:

key - The rendering option, that should be configured

value - The configuration value for the given option

See Also:

RenderingHints.Key.isCompatibleValue(Object)

set

public RenderingOptions set(RenderingHints.Key key,
                            Object value)

Set the rendering option.

Parameters:

key - The rendering option, that should be configured

value - The configuration value for the given option

Returns:

Actual RenderingOptions

setAntiAliasing

public RenderingOptions setAntiAliasing(Boolean on)

Sets the anti aliasing option. If null is passed, the default behavior will be activated.

Parameters:

on - The anti aliasing status used.

See Also:

RenderingHints.KEY_ANTIALIASING

setAntiAliasingForText

public RenderingOptions setAntiAliasingForText(Boolean on)

Sets the anti aliasing option for text drawing. If null is passed, the default behavior will be activated. More options may be available using put method.

Parameters:

on - The anti aliasing status used.

See Also:

RenderingHints.KEY_TEXT_ANTIALIASING

setFractionalMetrics

public RenderingOptions setFractionalMetrics(Boolean on)

Sets the fractional metrics option. If null is passed, the default behavior will be activated.

Parameters:

on - The fractional metrics status used.

See Also:

RenderingHints.KEY_FRACTIONALMETRICS

setStrokeControl

public RenderingOptions setStrokeControl(Boolean on)

Sets the stroke control option. If null is passed, the default behavior will be activated. If true, strokes will be normalized.

Parameters:

on - The stroke control status used.

See Also:

RenderingHints.KEY_STROKE_CONTROL

setDithering

public RenderingOptions setDithering(Boolean on)

Sets the dithering option. If null is passed, the default behavior will be activated.

Parameters:

on - The dithering status used.

See Also:

RenderingHints.KEY_DITHERING

setEnhancedColorRednering

public RenderingOptions setEnhancedColorRednering(Boolean on)

Sets the enhanced color rendering option. If null is passed, the default behavior will be activated. If true, the color rendering will try to produce the best possible result, but may be much slower.

Parameters:

on - The enhanced status status used.

See Also:

RenderingHints.KEY_COLOR_RENDERING

setEnhancedRednering

public RenderingOptions setEnhancedRednering(Boolean on)

Sets the enhanced rendering option. If null is passed, the default behavior will be activated. If true, the rendering will try to produce the best possible result, but may be much slower.

Parameters:

on - The enhanced status status used.

See Also:

RenderingHints.KEY_RENDERING

setEnhancedInterpolation

public RenderingOptions setEnhancedInterpolation(Boolean on)

Sets the enhanced interpolation option. If null is passed, the default behavior will be activated. If true, the interpolation will try to produce the best possible result, but may be much slower.

Parameters:

on - The enhanced status status used.

See Also:

RenderingHints.KEY_INTERPOLATION

setEnhancedAlphaInterpolation

public RenderingOptions setEnhancedAlphaInterpolation(Boolean on)

Sets the enhanced alpha interpolation option. If null is passed, the default behavior will be activated. If true, the alpha interpolation will try to produce the best possible result, but may be much slower.

Parameters:

on - The enhanced status status used.

See Also:

RenderingHints.KEY_ALPHA_INTERPOLATION

setTextLcdContrast

public RenderingOptions setTextLcdContrast(int contrast)

Controls the LCD contrast level.

Parameters:

contrast - The used contrast level

See Also:

RenderingHints.KEY_TEXT_LCD_CONTRAST

apply

public RenderingOptions apply(Graphics g)

Apply this rendering settings to an Graphics object. Previous options will remain and aren't overwritten.

Parameters:

g - The Graphics object used for configuration purpose

See Also:

apply(Graphics,boolean)

apply

public RenderingOptions apply(Graphics g,
                              boolean fullyReplace)

Apply this rendering settings to an Graphics object. This will try to cast it to a Graphics2D object, as only this will support those settings.

Parameters:

g - The Graphics object used for configuration purpose

fullyReplace - If true, all options set before will be discarded

See Also:

apply(Graphics2D,boolean)

apply

public RenderingOptions apply(Graphics2D g,
                              boolean fullyReplace)

Apply this rendering settings to an Graphics2D object. Behaves like Graphics2D.addRenderingHints(java.util.Map).

Parameters:

g - The Graphics object used for configuration purpose

fullyReplace - If true, all options set before will be discarded