pulpcore.image.filter
Class MotionBlur

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

public final class MotionBlur
extends Filter

The MotionBlur filter simulates the streaking of rapidly moving objects.

Field Summary

Fixed	angle The motion angle in radians, typically from -Math.PI/2 to Math.PI/2.
Fixed	distance The motion distance in pixels.

Constructor Summary

MotionBlur()
Create a MotionBlur filter with an angle of 0 and a distance of 4.

MotionBlur(float angle)
Create a MotionBlur filter with the specified angle and a distance of 4.

MotionBlur(float angle, float distance)
Create a MotionBlur filter with the specified angle and the specified distance.

Method Summary

Filter	copy() Creates a copy of the Filter for another Sprite to use.
protected void	filter(CoreImage input, CoreImage output) Performs this filter on the input image onto the specified output image.
boolean	getClampEdges() Gets whether the edges of the output is clamped (sharp edges).
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	setClampEdges(boolean clamp) Sets whether the edges of the output is clamped (sharp edges).
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

distance

public final Fixed distance

The motion distance in pixels. The maximum value is 255. The default value is 4.

angle

public final Fixed angle

The motion angle in radians, typically from -Math.PI/2 to Math.PI/2.

Constructor Detail

MotionBlur

public MotionBlur()

Create a MotionBlur filter with an angle of 0 and a distance of 4.

MotionBlur

public MotionBlur(float angle)

Create a MotionBlur filter with the specified angle and a distance of 4.

MotionBlur

public MotionBlur(float angle,
                  float distance)

Create a MotionBlur filter with the specified angle and the specified distance.

Method Detail

setClampEdges

public void setClampEdges(boolean clamp)

Sets whether the edges of the output is clamped (sharp edges). The default is false (blurry edges).

See Also:

getClampEdges()

getClampEdges

public boolean getClampEdges()

Gets whether the edges of the output is clamped (sharp edges). The default is false (blurry edges).

See Also:

setClampEdges(boolean)

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

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

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

filter

protected void filter(CoreImage input,
                      CoreImage output)

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