pulpcore.image.filter
Class DropShadow

java.lang.Object
  pulpcore.image.filter.Filter
      pulpcore.image.filter.Blur
          pulpcore.image.filter.DropShadow

public class DropShadow
extends Blur

A simple drop shadow.

Author:

David Brackeen, Florent Dupont

Field Summary

Color	color The shadow color.
Int	shadowOffsetX The shadow x offset.
Int	shadowOffsetY The shadow y offset.

Fields inherited from class pulpcore.image.filter.Blur

quality, radius

Constructor Summary

DropShadow()
Creates a Shadow filter with an offset of (3,3), the default shadow color (black with 50% alpha) and the default Blur values.

DropShadow(DropShadow filter)
Copy constructor.

DropShadow(int offsetX, int offsetY)
Creates a Shadow filter with the specified X and Y offset, the default shadow color (black with 50% alpha) and the default Blur values.

DropShadow(int offsetX, int offsetY, int shadowColor)
Creates a Shadow filter with the specified X and Y offset and shadow color, and the default Blur values.

DropShadow(int offsetX, int offsetY, int shadowColor, float radius)
Creates a Shadow filter with the specified X and Y offset, shadow color, and shadow radius.

DropShadow(int offsetX, int offsetY, int shadowColor, float radius, int quality)
Creates a Shadow filter with the specified X and Y offset, shadow color, shadow radius and shadow quality, from 1 (fastes) to 3 (Guassian approximation).

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.
int	getWidth() Gets the width of the output of this filter.
int	getX() Gets the x offset the output image should display relative to the input.
int	getY() Gets the y offset the output image should display relative to the input.
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.Blur

filter, getClampEdges, setClampEdges

Methods inherited from class pulpcore.image.filter.Filter

filter, getInput, getOutput, isDirty, setDirty, setInput

Methods inherited from class java.lang.Object

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

Field Detail

shadowOffsetX

public final Int shadowOffsetX

The shadow x offset. The default value is 3.

shadowOffsetY

public final Int shadowOffsetY

The shadow y offset. The default value is 3.

color

public final Color color

The shadow color. The default value is black with 50% alpha.

Constructor Detail

DropShadow

public DropShadow()

Creates a Shadow filter with an offset of (3,3), the default shadow color (black with 50% alpha) and the default Blur values.

DropShadow

public DropShadow(int offsetX,
                  int offsetY)

Creates a Shadow filter with the specified X and Y offset, the default shadow color (black with 50% alpha) and the default Blur values.

DropShadow

public DropShadow(int offsetX,
                  int offsetY,
                  int shadowColor)

Creates a Shadow filter with the specified X and Y offset and shadow color, and the default Blur values.

DropShadow

public DropShadow(int offsetX,
                  int offsetY,
                  int shadowColor,
                  float radius)

Creates a Shadow filter with the specified X and Y offset, shadow color, and shadow radius.

DropShadow

public DropShadow(int offsetX,
                  int offsetY,
                  int shadowColor,
                  float radius,
                  int quality)

Creates a Shadow filter with the specified X and Y offset, shadow color, shadow radius and shadow quality, from 1 (fastes) to 3 (Guassian approximation).

DropShadow

public DropShadow(DropShadow filter)

Copy constructor. Subclasses can use this to help implement copy().

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;
        }
        

Overrides:

copy in class Blur

update

public void update(int elapsedTime)

Description copied from class: Filter

Updates the filter. The default method does nothing.

Overrides:

update in class Blur

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 Blur

getX

public int getX()

Description copied from class: Filter

Gets the x offset the output image should display relative to the input.

Overrides:

getX in class Blur

getY

public int getY()

Description copied from class: Filter

Gets the y offset the output image should display relative to the input.

Overrides:

getY in class Blur

getWidth

public int getWidth()

Description copied from class: Filter

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

Overrides:

getWidth in class Blur

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 Blur

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.

Overrides:

filter in class Blur