pulpcore.image.filter
Class Reflection

java.lang.Object
  pulpcore.image.filter.Filter
      pulpcore.image.filter.Reflection

public final class Reflection
extends Filter

A Reflection filter. Fake a mirrored image on brilliant surface.

Author:

Florent Dupont

Field Summary

Int	bottomAlpha The alpha of the bottom of the reflection (farthest from from the bottom of the image), from 0 to 255.
Fixed	fraction The reflection height as a fraction of the input image, from 0 to 1.
Int	gap The vertical gap, in pixels, between the bottom of the image and the top of the reflection.
Int	topAlpha The alpha of the top of the reflection (nearest the bottom of the image), from 0 to 255.

Constructor Summary

Reflection()
Creates a Reflection filter with the default parameters.

Reflection(int gap)
Creates a Reflection filter with the specified gap.

Reflection(int gap, float fraction)
Creates a Reflection filter with the specified gap and reflection height (as a fraction of the input image).

Reflection(int gap, float fraction, int topAlpha, int bottomAlpha)
Creates a Reflection filter with the specified gap, (as a fraction of the input image), and alpha values.

Method Summary

Filter	copy() Creates a copy of the Filter for another Sprite to use.
protected void	filter(CoreImage src, CoreImage dst) Performs this filter on the input image onto the specified output image.
int	getHeight() Gets the height of the output of this filter.
boolean	isOpaque() Returns true if the output of this filter is opaque.
void	update(int elapsedTime) Updates the filter.

Methods inherited from class pulpcore.image.filter.Filter

filter, getInput, getOutput, getWidth, getX, getY, isDirty, setDirty, setInput

Methods inherited from class java.lang.Object

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

Field Detail

gap

public final Int gap

The vertical gap, in pixels, between the bottom of the image and the top of the reflection. The default value is 1.

fraction

public final Fixed fraction

The reflection height as a fraction of the input image, from 0 to 1. The default value is 0.75.

topAlpha

public final Int topAlpha

The alpha of the top of the reflection (nearest the bottom of the image), from 0 to 255. The default value is 128.

bottomAlpha

public final Int bottomAlpha

The alpha of the bottom of the reflection (farthest from from the bottom of the image), from 0 to 255. The default value is 0.

Constructor Detail

Reflection

public Reflection()

Creates a Reflection filter with the default parameters.

Reflection

public Reflection(int gap)

Creates a Reflection filter with the specified gap.

Reflection

public Reflection(int gap,
                  float fraction)

Creates a Reflection filter with the specified gap and reflection height (as a fraction of the input image).

Reflection

public Reflection(int gap,
                  float fraction,
                  int topAlpha,
                  int bottomAlpha)

Creates a Reflection filter with the specified gap, (as a fraction of the input image), and alpha values.

Method Detail

copy

public Filter copy()

Description copied from class: Filter

Creates a copy of the Filter for another Sprite to use. The input filter is also copied. The properties of the copy, if any, will be bound to the original filter's properties.

This method is used by the Sprite class. Most apps will not need to call this method.

Subclasses should bind all properties of the cloned object using bindWithInverse(). For example, for the HSBAdjust filter:

        public Filter copy() {
            HSBAdjust copy = new HSBAdjust();
            copy.hue.bindWithInverse(hue);
            copy.brightness.bindWithInverse(brightness);
            copy.saturation.bindWithInverse(saturation);
            return copy;
        }
        

Specified by:

copy in class Filter

getHeight

public int getHeight()

Description copied from class: Filter

Gets the height of the output of this filter. By default, the height is the same as the input's height.

Overrides:

getHeight in class Filter

isOpaque

public boolean isOpaque()

Description copied from class: Filter

Returns true if the output of this filter is opaque. By default, the output is opaque if the input is opaque.

Overrides:

isOpaque in class Filter

update

public void update(int elapsedTime)

Description copied from class: Filter

Updates the filter. The default method does nothing.

Overrides:

update in class Filter

filter

protected void filter(CoreImage src,
                      CoreImage dst)

Description copied from class: Filter

Performs this filter on the input image onto the specified output image.

This method is called from Filter.getOutput() if Filter.isDirty() returns true. The output image will be the same dimensions as (Filter.getWidth() x Filter.getHeight(). Implementors must ensure that every pixel in output is drawn.

Specified by:

filter in class Filter