com.jhlabs.image

Class TwirlFilter

Implemented Interfaces:
BufferedImageOp, Cloneable

public class TwirlFilter
extends TransformFilter

A Filter which distorts an image by twisting it from the centre out. The twisting is centred at the centre of the image and extends out to the smallest of the width and height. Pixels outside this radius are unaffected.

Field Summary

Fields inherited from class com.jhlabs.image.TransformFilter

BILINEAR, CLAMP, NEAREST_NEIGHBOUR, RGB_CLAMP, WRAP, ZERO, edgeAction, interpolation, originalSpace, transformedSpace

Constructor Summary

TwirlFilter()
Construct a TwirlFilter with no distortion.

Method Summary

BufferedImage
filter(BufferedImage src, BufferedImage dst)
float
getAngle()
Get the angle of twist.
Point2D
getCentre()
Get the centre of the effect as a proportion of the image size.
float
getCentreX()
Get the centre of the effect in the X direction as a proportion of the image size.
float
getCentreY()
Get the centre of the effect in the Y direction as a proportion of the image size.
float
getRadius()
Get the radius of the effect.
void
setAngle(float angle)
Set the angle of twirl in radians.
void
setCentre(Point2D centre)
Set the centre of the effect as a proportion of the image size.
void
setCentreX(float centreX)
Set the centre of the effect in the X direction as a proportion of the image size.
void
setCentreY(float centreY)
Set the centre of the effect in the Y direction as a proportion of the image size.
void
setRadius(float radius)
Set the radius of the effect.
String
toString()
protected void
transformInverse(int x, int y, float[] out)
Inverse transform a point.

Methods inherited from class com.jhlabs.image.TransformFilter

filter, filterPixelsNN, getEdgeAction, getInterpolation, setEdgeAction, setInterpolation, transformInverse, transformSpace

Methods inherited from class com.jhlabs.image.AbstractBufferedImageOp

clone, createCompatibleDestImage, getBounds2D, getPoint2D, getRGB, getRenderingHints, setRGB

Constructor Details

TwirlFilter

public TwirlFilter()
Construct a TwirlFilter with no distortion.

Method Details

filter

public BufferedImage filter(BufferedImage src,
                            BufferedImage dst)
Overrides:
filter in interface TransformFilter

getAngle

public float getAngle()
Get the angle of twist.
Returns:
the angle in radians.

getCentre

public Point2D getCentre()
Get the centre of the effect as a proportion of the image size.
Returns:
the center

getCentreX

public float getCentreX()
Get the centre of the effect in the X direction as a proportion of the image size.
Returns:
the center

getCentreY

public float getCentreY()
Get the centre of the effect in the Y direction as a proportion of the image size.
Returns:
the center

getRadius

public float getRadius()
Get the radius of the effect.
Returns:
the radius

setAngle

public void setAngle(float angle)
Set the angle of twirl in radians. 0 means no distortion.
Parameters:
angle - the angle of twirl. This is the angle by which pixels at the nearest edge of the image will move.

setCentre

public void setCentre(Point2D centre)
Set the centre of the effect as a proportion of the image size.
Parameters:
centre - the center

setCentreX

public void setCentreX(float centreX)
Set the centre of the effect in the X direction as a proportion of the image size.
Parameters:
centreX - the center

setCentreY

public void setCentreY(float centreY)
Set the centre of the effect in the Y direction as a proportion of the image size.
Parameters:
centreY - the center

setRadius

public void setRadius(float radius)
Set the radius of the effect.
Parameters:
radius - the radius

toString

public String toString()

transformInverse

protected void transformInverse(int x,
                                int y,
                                float[] out)
Inverse transform a point. This method needs to be overriden by all subclasses.
Overrides:
transformInverse in interface TransformFilter
Parameters:
x - the X position of the pixel in the output image
y - the Y position of the pixel in the output image
out - the position of the pixel in the input image