com.sun.scenario.effect

Class GaussianShadow

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.FilterEffect<T>

com.sun.scenario.effect.CoreEffect<LinearConvolveRenderState>

com.sun.scenario.effect.LinearConvolveCoreEffect

com.sun.scenario.effect.AbstractShadow

com.sun.scenario.effect.GaussianShadow

public class GaussianShadow
extends AbstractShadow

A blurred shadow effect using a Gaussian convolution kernel, with a configurable radius and shadow color. Only the alpha channel of the input is used to create the shadow effect. The alpha value of each pixel from the result of the blur operation is modulated with the specified shadow color to produce the resulting image.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.AbstractShadow

AbstractShadow.ShadowMode

Nested classes/interfaces inherited from class com.sun.scenario.effect.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private GaussianShadowState	state

Fields inherited from class com.sun.scenario.effect.Effect

DefaultInput

Constructor Summary

Constructors

Constructor and Description
GaussianShadow() Constructs a new GaussianShadow effect with the default radius (10.0) and the default color (Color4f.BLACK), using the default input for source data.
GaussianShadow(float radius) Constructs a new GaussianShadow effect with the given radius and the default color (Color4f.BLACK), using the default input for source data.
GaussianShadow(float radius, Color4f color) Constructs a new GaussianShadow effect with the given radius and color, using the default input for source data.
GaussianShadow(float radius, Color4f color, Effect input) Constructs a new GaussianShadow effect with the given radius and color.

Method Summary

Modifier and Type	Method and Description
Effect.AccelType	getAccelType(FilterContext fctx) Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.
BaseBounds	getBounds(BaseTransform transform, Effect defaultInput) Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect.
Color4f	getColor() Returns the shadow color.
DirtyRegionContainer	getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Returns the dirty region container containing dirty regions affected by this filter operation.
float	getGaussianHeight()
float	getGaussianRadius()
float	getGaussianWidth()
float	getHRadius() Returns the horizontal radius of the Gaussian kernel.
Effect	getInput() Returns the input for this Effect.
AbstractShadow.ShadowMode	getMode()
float	getRadius() Returns the radius of the Gaussian kernel.
Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas)
float	getSpread() Gets the spread of the shadow effect.
(package private) LinearConvolveKernel	getState() Returns state object that is associated with this effect instance.
float	getVRadius() Returns the vertical radius of the Gaussian kernel.
AbstractShadow	implFor(AbstractShadow.ShadowMode mode)
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setColor(Color4f color) Sets the shadow color.
void	setGaussianHeight(float h)
void	setGaussianRadius(float r)
void	setGaussianWidth(float w)
void	setHRadius(float hradius) Sets the horizontal radius of the Gaussian kernel.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setRadius(float radius) Sets the radius of the Gaussian kernel.
void	setSpread(float spread) Sets the spread of the shadow effect.
void	setVRadius(float vradius) Sets the vertical radius of the Gaussian kernel.

Methods inherited from class com.sun.scenario.effect.LinearConvolveCoreEffect

filterImageDatas, getRenderState

Methods inherited from class com.sun.scenario.effect.CoreEffect

getPeer, updatePeerKey, updatePeerKey

Methods inherited from class com.sun.scenario.effect.FilterEffect

filter, transform, untransform, untransformClip

Methods inherited from class com.sun.scenario.effect.Effect

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

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

Field Detail

state

private GaussianShadowState state

Constructor Detail

GaussianShadow

public GaussianShadow()

Constructs a new GaussianShadow effect with the default radius (10.0) and the default color (Color4f.BLACK), using the default input for source data. This is a shorthand equivalent to:

     new GaussianShadow(10f, Color4f.BLACK, DefaultInput)
 

GaussianShadow

public GaussianShadow(float radius)

Constructs a new GaussianShadow effect with the given radius and the default color (Color4f.BLACK), using the default input for source data. This is a shorthand equivalent to:

     new GaussianShadow(radius, Color4f.BLACK, DefaultInput)
 

Parameters:

radius - the radius of the Gaussian kernel

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range

GaussianShadow

public GaussianShadow(float radius,
                      Color4f color)

Constructs a new GaussianShadow effect with the given radius and color, using the default input for source data. This is a shorthand equivalent to:

     new GaussianShadow(radius, color, DefaultInput)
 

Parameters:

radius - the radius of the Gaussian kernel

color - the shadow Color4f

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range

GaussianShadow

public GaussianShadow(float radius,
                      Color4f color,
                      Effect input)

Constructs a new GaussianShadow effect with the given radius and color.

Parameters:

radius - the radius of the Gaussian kernel

color - the shadow Color4f

input - the single input Effect

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range, or if color is null

Method Detail

getState

LinearConvolveKernel getState()

Description copied from class: Effect

Returns state object that is associated with this effect instance. Subclasses may override this method to return some sort of state object that contains implementation details that are hidden from the public API. Classes outside this package can use the AccessHelper class to get access to this package-private method.

Specified by:

getState in class LinearConvolveCoreEffect

getAccelType

public Effect.AccelType getAccelType(FilterContext fctx)

Description copied from class: Effect

Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.

Overrides:

getAccelType in class CoreEffect<LinearConvolveRenderState>

Returns:

one of the AccelType values

getInput

public final Effect getInput()

Returns the input for this Effect.

Specified by:

getInput in class AbstractShadow

Returns:

the input for this Effect

setInput

public void setInput(Effect input)

Sets the input for this Effect to a specific Effect or to the default input if input is null.

Specified by:

setInput in class AbstractShadow

Parameters:

input - the input for this Effect

getRadius

public float getRadius()

Returns the radius of the Gaussian kernel.

Returns:

the radius of the Gaussian kernel

setRadius

public void setRadius(float radius)

Sets the radius of the Gaussian kernel.

       Min:   0.0
       Max: 127.0
   Default:  10.0
  Identity:   0.0
 

Parameters:

radius - the radius of the Gaussian kernel

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range

getHRadius

public float getHRadius()

Returns the horizontal radius of the Gaussian kernel.

Returns:

the horizontal radius of the Gaussian kernel

setHRadius

public void setHRadius(float hradius)

Sets the horizontal radius of the Gaussian kernel.

       Min:   0.0
       Max: 127.0
   Default:  10.0
  Identity:   0.0
 

Parameters:

hradius - the horizontal radius of the Gaussian kernel

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range

getVRadius

public float getVRadius()

Returns the vertical radius of the Gaussian kernel.

Returns:

the vertical radius of the Gaussian kernel

setVRadius

public void setVRadius(float vradius)

Sets the vertical radius of the Gaussian kernel.

       Min:   0.0
       Max: 127.0
   Default:  10.0
  Identity:   0.0
 

Parameters:

vradius - the vertical radius of the Gaussian kernel

Throws:

java.lang.IllegalArgumentException - if radius is outside the allowable range

getSpread

public float getSpread()

Gets the spread of the shadow effect.

Specified by:

getSpread in class AbstractShadow

Returns:

the spread of the shadow effect

setSpread

public void setSpread(float spread)

Sets the spread of the shadow effect. The spread is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the Gaussian kernel. A spread of 0.0 will result in a pure Gaussian distribution of the shadow. A spread of 1.0 will result in a solid growth outward of the source material opacity to the limit of the radius with a very sharp cutoff to transparency at the radius.

       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 0.0
 

Specified by:

setSpread in class AbstractShadow

Parameters:

spread - the spread of the shadow effect

Throws:

java.lang.IllegalArgumentException - if spread is outside the allowable range

getColor

public Color4f getColor()

Returns the shadow color.

Specified by:

getColor in class AbstractShadow

Returns:

the shadow color

setColor

public void setColor(Color4f color)

Sets the shadow color.

       Min: n/a
       Max: n/a
   Default: Color4f.BLACK
  Identity: n/a
 

Specified by:

setColor in class AbstractShadow

Parameters:

color - the shadow color

Throws:

java.lang.IllegalArgumentException - if color is null

getGaussianRadius

public float getGaussianRadius()

Specified by:

getGaussianRadius in class AbstractShadow

getGaussianWidth

public float getGaussianWidth()

Specified by:

getGaussianWidth in class AbstractShadow

getGaussianHeight

public float getGaussianHeight()

Specified by:

getGaussianHeight in class AbstractShadow

setGaussianRadius

public void setGaussianRadius(float r)

Specified by:

setGaussianRadius in class AbstractShadow

setGaussianWidth

public void setGaussianWidth(float w)

Specified by:

setGaussianWidth in class AbstractShadow

setGaussianHeight

public void setGaussianHeight(float h)

Specified by:

setGaussianHeight in class AbstractShadow

getMode

public AbstractShadow.ShadowMode getMode()

Specified by:

getMode in class AbstractShadow

implFor

public AbstractShadow implFor(AbstractShadow.ShadowMode mode)

Specified by:

implFor in class AbstractShadow

getBounds

public BaseBounds getBounds(BaseTransform transform,
                            Effect defaultInput)

Description copied from class: Effect

Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect. Note that the returned bounds can be smaller or larger than one or more of the inputs.

Overrides:

getBounds in class FilterEffect<LinearConvolveRenderState>

Parameters:

transform - the transform the effect will be viewed under

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the bounding box of this filter

getResultBounds

public Rectangle getResultBounds(BaseTransform transform,
                                 Rectangle outputClip,
                                 ImageData... inputDatas)

Overrides:

getResultBounds in class Effect

reducesOpaquePixels

public boolean reducesOpaquePixels()

Description copied from class: Effect

Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input. It is always safe to return true from this method, though the consequences may be that the caller chooses to not utilize a planned optimization.

Specified by:

reducesOpaquePixels in class Effect

Returns:

true if this effect may reduce opacity of some pixels of one of it's input (and thus the default input) or it's relevant input(s) might have reduced opaque pixels of the default input already.

getDirtyRegions

public DirtyRegionContainer getDirtyRegions(Effect defaultInput,
                                            DirtyRegionPool regionPool)

Description copied from class: Effect

Returns the dirty region container containing dirty regions affected by this filter operation.

Overrides:

getDirtyRegions in class Effect

Parameters:

defaultInput - the default input Effect to be used in all cases where a filter has a null input

regionPool - the pool of dirty regions

Returns:

the dirty region container