pulpcore.image.filter
Class Stroke

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

public final class Stroke
extends Filter

A edge Stroke filter.

An example can be found here: http://www.webdesign.org/web/photoshop/photoshop-basics/stroke-a-stroke-in-photoshop.14342.html Example of use (to obtain the same effect as the above PSD example):

 ImageSprite sprite = new ImageSprite("star.png", 50, 50);
 FilterChain chain = new FilterChain(new Stroke(0xff289acd, 7), new Stroke(0xFF00679A, 7));
 sprite.setFilter(chain);
 add(sprite);
 

Author:

Florent Dupont

Field Summary

Color	color The stroke color.
Int	size The stroke size.

Constructor Summary

Stroke()
Creates a Stroke filter with the default color (black) and a size of 5.

Stroke(int color)
Creates a Stroke filter with the specified color and a size of 5.

Stroke(int color, int radius)
Creates a Stroke filter with the specified color and size.

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

color

public final Color color

The stroke color. The default color is black.

size

public final Int size

The stroke size. The minimum value is 1. The default value is 5.

Constructor Detail

Stroke

public Stroke()

Creates a Stroke filter with the default color (black) and a size of 5.

Stroke

public Stroke(int color)

Creates a Stroke filter with the specified color and a size of 5.

Stroke

public Stroke(int color,
              int radius)

Creates a Stroke filter with the specified color and size.

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

update

public void update(int elapsedTime)

Description copied from class: Filter

Updates the filter. The default method does nothing.

Overrides:

update 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

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 Filter

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 Filter

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

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