com.sun.scenario.effect

Class DropShadow

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.DelegateEffect

com.sun.scenario.effect.DropShadow

public class DropShadow
extends DelegateEffect

A high-level effect that renders a shadow of the given content behind the content with the specified color, radius, and offset.

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 Merge	merge
private Offset	offset
private AbstractShadow	shadow

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
DropShadow() Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0), using the default input for source data.
DropShadow(Effect input) Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0).
DropShadow(Effect shadowSourceInput, Effect contentInput) Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0).

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.
Color4f	getColor() Returns the shadow color.
Effect	getContentInput() Returns the content input for this Effect.
protected Effect	getDelegate() Returns the Effect object to delegate all operations to.
float	getGaussianHeight()
float	getGaussianRadius()
float	getGaussianWidth()
int	getOffsetX() Returns the offset in the x direction, in pixels.
int	getOffsetY() Returns the offset in the x direction, in pixels.
float	getRadius() Returns the radius of the Gaussian kernel.
AbstractShadow.ShadowMode	getShadowMode()
Effect	getShadowSourceInput() Returns the shadow source input for this Effect.
float	getSpread() Gets the spread of the shadow effect.
void	setColor(Color4f color) Sets the shadow color.
void	setContentInput(Effect contentInput) Sets the content input for this Effect.
void	setGaussianHeight(float h)
void	setGaussianRadius(float r)
void	setGaussianWidth(float w)
void	setOffsetX(int xoff) Sets the offset in the x direction, in pixels.
void	setOffsetY(int yoff) Sets the offset in the y direction, in pixels.
void	setRadius(float radius) Sets the radius of the shadow blur kernel.
void	setShadowMode(AbstractShadow.ShadowMode mode)
void	setShadowSourceInput(Effect shadowSourceInput) Sets the shadow source input for this Effect.
void	setSpread(float spread) Sets the spread of the shadow effect.

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

filter, 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

offset

private final Offset offset

merge

private final Merge merge

Constructor Detail

DropShadow

public DropShadow()

Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0), using the default input for source data. This is a shorthand equivalent to:

     new DropShadow(DefaultInput, DefaultInput)
 

DropShadow

public DropShadow(Effect input)

Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0). This is a shorthand equivalent to:

     new DropShadow(input, input);
 

Parameters:

input - the single input Effect

DropShadow

public DropShadow(Effect shadowSourceInput,
                  Effect contentInput)

Constructs a new DropShadow effect, with the default blur radius (10.0), x offset (0.0), and y offset (0.0).

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

The shadowSourceInput is used to create the background shadow, and the contentInput is used to render the content over that shadow.

Parameters:

shadowSourceInput - the input Effect used to create the background shadow

contentInput - the input Effect used to render the content over 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.

getShadowSourceInput

public final Effect getShadowSourceInput()

Returns the shadow source input for this Effect.

Returns:

the shadow source input for this Effect

setShadowSourceInput

public void setShadowSourceInput(Effect shadowSourceInput)

Sets the shadow source input for this Effect.

Parameters:

shadowSourceInput - the shadow source input for this Effect

Throws:

java.lang.IllegalArgumentException - if shadowSourceInput is null

getContentInput

public final Effect getContentInput()

Returns the content input for this Effect.

Returns:

the content input for this Effect

setContentInput

public void setContentInput(Effect contentInput)

Sets the content input for this Effect.

Parameters:

contentInput - the content input for this Effect

Throws:

java.lang.IllegalArgumentException - if contentInput 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

getOffsetX

public int getOffsetX()

Returns the offset in the x direction, in pixels.

Returns:

the offset in the x direction, in pixels.

setOffsetX

public void setOffsetX(int xoff)

Sets the offset in the x direction, in pixels.

       Min: Integer.MIN_VALUE
       Max: Integer.MAX_VALUE
   Default: 0
  Identity: 0
 

Parameters:

xoff - the offset in the x direction, in pixels

getOffsetY

public int getOffsetY()

Returns the offset in the x direction, in pixels.

Returns:

the offset in the x direction, in pixels.

setOffsetY

public void setOffsetY(int yoff)

Sets the offset in the y direction, in pixels.

       Min: Integer.MIN_VALUE
       Max: Integer.MAX_VALUE
   Default: 0
  Identity: 0
 

Parameters:

yoff - the offset in the y direction, in pixels

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 DelegateEffect

Returns:

one of the AccelType values