com.sun.scenario.effect

Class Reflection

java.lang.Object

com.sun.scenario.effect.Effect

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

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

com.sun.scenario.effect.Reflection

public class Reflection
extends CoreEffect<RenderState>

An effect that renders a reflected version of the input below the actual input content.

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 float	bottomOpacity
private float	fraction
private float	topOffset
private float	topOpacity

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
Reflection() Constructs a new Reflection effect with default values, using the default input for source data.
Reflection(Effect input) Constructs a new Reflection effect with default values.

Method Summary

Modifier and Type	Method and Description
float	getBottomOpacity() Returns the bottom opacity value, which is the opacity of the reflection at its bottom extreme.
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.
DirtyRegionContainer	getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Returns the dirty region container containing dirty regions affected by this filter operation.
float	getFraction() Returns the fraction of the input that is visible in the reflection.
Effect	getInput() Returns the input for this Effect.
RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput) Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
float	getTopOffset() Returns the top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
float	getTopOpacity() Returns the top opacity value, which is the opacity of the reflection at its top extreme.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setBottomOpacity(float bottomOpacity) Sets the bottom opacity value, which is the opacity of the reflection at its bottom extreme.
void	setFraction(float fraction) Sets the fraction of the input that is visible in the reflection.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setTopOffset(float topOffset) Sets the top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
void	setTopOpacity(float topOpacity) Sets the top opacity value, which is the opacity of the reflection at its top extreme.
Point2D	transform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output.
Point2D	untransform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input.

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

filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey

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

filter, untransformClip

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

topOffset

private float topOffset

topOpacity

private float topOpacity

bottomOpacity

private float bottomOpacity

fraction

private float fraction

Constructor Detail

Reflection

public Reflection()

Constructs a new Reflection effect with default values, using the default input for source data. This is a shorthand equivalent to:

     new Reflection(DefaultInput)
 

Reflection

public Reflection(Effect input)

Constructs a new Reflection effect with default values.

Parameters:

input - the single input Effect

Method Detail

getInput

public final Effect getInput()

Returns the input for this Effect.

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.

Parameters:

input - the input for this Effect

getTopOffset

public float getTopOffset()

Returns the top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.

Returns:

the top offset adjustment

setTopOffset

public void setTopOffset(float topOffset)

Sets the top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 

Parameters:

topOffset - the top offset adjustment

getTopOpacity

public float getTopOpacity()

Returns the top opacity value, which is the opacity of the reflection at its top extreme.

Returns:

the top opacity value

setTopOpacity

public void setTopOpacity(float topOpacity)

Sets the top opacity value, which is the opacity of the reflection at its top extreme.

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

Parameters:

topOpacity - the top opacity value

Throws:

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

getBottomOpacity

public float getBottomOpacity()

Returns the bottom opacity value, which is the opacity of the reflection at its bottom extreme.

Returns:

the bottom opacity value

setBottomOpacity

public void setBottomOpacity(float bottomOpacity)

Sets the bottom opacity value, which is the opacity of the reflection at its bottom extreme.

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

Parameters:

bottomOpacity - the bottom opacity value

Throws:

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

getFraction

public float getFraction()

Returns the fraction of the input that is visible in the reflection.

Returns:

the fraction value

setFraction

public void setFraction(float fraction)

Sets the fraction of the input that is visible in the reflection. For example, a value of 0.5 means that only the bottom half of the input will be visible in the reflection.

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

Parameters:

fraction - the fraction of the input that is visible in the reflection

Throws:

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

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<RenderState>

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

transform

public Point2D transform(Point2D p,
                         Effect defaultInput)

Description copied from class: Effect

Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output. In essence, this method asks the question "Which output coordinate is most affected by the data at the specified coordinate in the primary source input?"

The definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map source coordinates to destination coordinates, but not the reverse. In particular, effects which map source coordinates discontiguously into the result may have several output coordinates that are affected by a given input coordinate and may choose to return one of many equally valid answers, or an undefined result such as NaN, or some other anomalous value. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

Overrides:

transform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the primary content input to be transformed

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

Returns:

the transformed point in the coordinate space of the result

untransform

public Point2D untransform(Point2D p,
                           Effect defaultInput)

Description copied from class: Effect

Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input. In essence, this method asks the question "Which source coordinate contributes most to the definition of the output at the specified coordinate?"

The definition of which input represents the primary content input and how the coordinate space of that input compares to the coordinate space of the result varies from effect to effect. Note that some effects may have a reasonable definition of how to map destination coordinates back to source coordinates, but not the reverse. In particular, effects which produce entirely synthetic results not based on any content input may not be able to give a meaningful result to this query and may return undefined coordinates such as 0, Infinity, or NaN. Most effects perform simple transformations of the color of each pixel and so represent an identity transform and return the point unchanged.

Overrides:

untransform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the result output to be transformed

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

Returns:

the untransformed point in the coordinate space of the primary content input

getRenderState

public RenderState getRenderState(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  java.lang.Object renderHelper,
                                  Effect defaultInput)

Description copied from class: FilterEffect

Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments. This call can also be used to get a state object for non-rendering cases like querying the bounds of an operation in which case the FilterContext object may be null. outputClip and renderHelper may always be null just as they may be null for a given filter operation.

Specified by:

getRenderState in class FilterEffect<RenderState>

Parameters:

fctx - the context object that would be used by the Renderer if this call is preparing for a render operation, or null

transform - the transform for the output of this operation

outputClip - the clip rectangle that may restrict this operation, or null

renderHelper - the rendering helper object that can be used to shortcut this operation under certain conditions, or null

defaultInput - the Effect to be used in place of any null inputs

Returns:

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