com.sun.scenario.effect

Class GeneralShadow

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.DelegateEffect

com.sun.scenario.effect.GeneralShadow

public class GeneralShadow
extends DelegateEffect

A blurred shadow effect using either a Gaussian convolution or a Box filter 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.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractShadow	shadow

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
GeneralShadow() Constructs a new GeneralShadow effect, with the default blur radius (10.0), using the default input for source data.
GeneralShadow(Effect input) Constructs a new GeneralShadow effect, with the default blur radius (10.0).

Method Summary

Modifier and Type	Method and Description
Color4f	getColor() Returns the shadow color.
protected Effect	getDelegate() Returns the Effect object to delegate all operations to.
float	getGaussianHeight()
float	getGaussianRadius()
float	getGaussianWidth()
Effect	getInput() Returns the shadow source input for this Effect.
float	getRadius() Returns the radius of the Gaussian kernel.
AbstractShadow.ShadowMode	getShadowMode()
float	getSpread() Gets the spread of the shadow effect.
void	setColor(Color4f color) Sets the shadow color.
void	setGaussianHeight(float h)
void	setGaussianRadius(float r)
void	setGaussianWidth(float w)
void	setInput(Effect input) Sets the shadow source input for this Effect.
void	setRadius(float radius) Sets the radius of the shadow blur kernel.
void	setShadowMode(AbstractShadow.ShadowMode mode)
void	setSpread(float spread) Sets the spread of the shadow effect.

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

filter, getAccelType, getBounds, getDirtyRegions, reducesOpaquePixels, transform, untransform

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

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

Methods inherited from class java.lang.Object

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

Field Detail

shadow

private AbstractShadow shadow

Constructor Detail

GeneralShadow

public GeneralShadow()

Constructs a new GeneralShadow effect, with the default blur radius (10.0), using the default input for source data. This is a shorthand equivalent to:

     new GeneralShadow(DefaultInput)
 

GeneralShadow

public GeneralShadow(Effect input)

Constructs a new GeneralShadow effect, with the default blur radius (10.0).

This constructor is intended for advanced developers only. Most developers will only ever need to use the default constructor.

Parameters:

input - the input Effect used to create the shadow

Method Detail

getShadowMode

public AbstractShadow.ShadowMode getShadowMode()

setShadowMode

public void setShadowMode(AbstractShadow.ShadowMode mode)

getDelegate

protected Effect getDelegate()

Description copied from class: DelegateEffect

Returns the Effect object to delegate all operations to.

Specified by:

getDelegate in class DelegateEffect

Returns:

the Effect object to delegate to.

getInput

public final Effect getInput()

Returns the shadow source input for this Effect.

Returns:

the shadow source input for this Effect

setInput

public void setInput(Effect input)

Sets the shadow source input for this Effect.

Parameters:

input - the shadow source input for this Effect

Throws:

java.lang.IllegalArgumentException - if input is null

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 shadow blur kernel.

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

Parameters:

radius - the radius of the shadow blur kernel

Throws:

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

getGaussianRadius

public float getGaussianRadius()

getGaussianWidth

public float getGaussianWidth()

getGaussianHeight

public float getGaussianHeight()

setGaussianRadius

public void setGaussianRadius(float r)

setGaussianWidth

public void setGaussianWidth(float w)

setGaussianHeight

public void setGaussianHeight(float h)

getSpread

public float getSpread()

Gets the spread of the shadow effect.

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
 

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.

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
 

Parameters:

color - the shadow color

Throws:

java.lang.IllegalArgumentException - if color is null