Package com.jhlabs.image

Class MotionBlurFilter

  • All Implemented Interfaces:
    MotionBlur, java.awt.image.BufferedImageOp, java.lang.Cloneable
    public class MotionBlurFilter
extends AbstractBufferedImageOp
implements MotionBlur
    A filter which produces motion blur the slow, but higher-quality way.

    • Constructor Summary

      Constructors 
      Constructor Description
      MotionBlurFilter()
      Construct a MotionBlurFilter.
      MotionBlurFilter​(float distance, float angle, float rotation, float zoom)
      Construct a MotionBlurFilter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.image.BufferedImage filter​(java.awt.image.BufferedImage src, java.awt.image.BufferedImage dst)  
      float getAngle()
      Returns the angle of blur.
      java.awt.geom.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 getDistance()
      Get the distance of blur.
      boolean getPremultiplyAlpha()
      Get whether to premultiply the alpha channel.
      float getRotation()
      Get the blur rotation.
      boolean getWrapEdges()
      Get whether to wrap at the image edges.
      float getZoom()
      Get the blur zoom.
      void setAngle​(float angle)
      Specifies the angle of blur.
      void setCentre​(java.awt.geom.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 setDistance​(float distance)
      Set the distance of blur.
      void setPremultiplyAlpha​(boolean premultiplyAlpha)
      Set whether to premultiply the alpha channel.
      void setRotation​(float rotation)
      Set the blur rotation.
      void setWrapEdges​(boolean wrapEdges)
      Set whether to wrap at the image edges.
      void setZoom​(float zoom)
      Set the blur zoom.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.awt.image.BufferedImageOp

        createCompatibleDestImage, getBounds2D, getPoint2D, getRenderingHints

    • Constructor Detail

      • MotionBlurFilter

        public MotionBlurFilter()
        Construct a MotionBlurFilter.

      • MotionBlurFilter

        public MotionBlurFilter​(float distance,
                        float angle,
                        float rotation,
                        float zoom)
        Construct a MotionBlurFilter.
        Parameters:
        distance - the distance of blur.
        angle - the angle of blur.
        rotation - the angle of rotation.
        zoom - the zoom factor.

    • Method Detail

      • setCentreX

        public void setCentreX​(float centreX)
        Set the centre of the effect in the X direction as a proportion of the image size.
        Specified by:
        setCentreX in interface MotionBlur
        Parameters:
        centreX - the center
        See Also:
        getCentreX()

      • getCentreX

        public float getCentreX()
        Get the centre of the effect in the X direction as a proportion of the image size.
        Specified by:
        getCentreX in interface MotionBlur
        Returns:
        the center
        See Also:
        setCentreX(float)

      • setCentreY

        public void setCentreY​(float centreY)
        Set the centre of the effect in the Y direction as a proportion of the image size.
        Specified by:
        setCentreY in interface MotionBlur
        Parameters:
        centreY - the center
        See Also:
        getCentreY()

      • getCentreY

        public float getCentreY()
        Get the centre of the effect in the Y direction as a proportion of the image size.
        Specified by:
        getCentreY in interface MotionBlur
        Returns:
        the center
        See Also:
        setCentreY(float)

      • setCentre

        public void setCentre​(java.awt.geom.Point2D centre)
        Set the centre of the effect as a proportion of the image size.
        Specified by:
        setCentre in interface MotionBlur
        Parameters:
        centre - the center
        See Also:
        getCentre()

      • setAngle

        public void setAngle​(float angle)
        Specifies the angle of blur.
        Specified by:
        setAngle in interface MotionBlur
        Parameters:
        angle - the angle of blur.
        See Also:
        getAngle()

      • getAngle

        public float getAngle()
        Returns the angle of blur.
        Specified by:
        getAngle in interface MotionBlur
        Returns:
        the angle of blur.
        See Also:
        setAngle(float)

      • setDistance

        public void setDistance​(float distance)
        Set the distance of blur.
        Specified by:
        setDistance in interface MotionBlur
        Parameters:
        distance - the distance of blur.
        See Also:
        getDistance()

      • setRotation

        public void setRotation​(float rotation)
        Set the blur rotation.
        Specified by:
        setRotation in interface MotionBlur
        Parameters:
        rotation - the angle of rotation.
        See Also:
        getRotation()

      • setZoom

        public void setZoom​(float zoom)
        Set the blur zoom.
        Specified by:
        setZoom in interface MotionBlur
        Parameters:
        zoom - the zoom factor.
        See Also:
        getZoom()

      • setWrapEdges

        public void setWrapEdges​(boolean wrapEdges)
        Set whether to wrap at the image edges.
        Parameters:
        wrapEdges - true if it should wrap.
        See Also:
        getWrapEdges()

      • getWrapEdges

        public boolean getWrapEdges()
        Get whether to wrap at the image edges.
        Returns:
        true if it should wrap.
        See Also:
        setWrapEdges(boolean)

      • setPremultiplyAlpha

        public void setPremultiplyAlpha​(boolean premultiplyAlpha)
        Set whether to premultiply the alpha channel.
        Parameters:
        premultiplyAlpha - true to premultiply the alpha
        See Also:
        getPremultiplyAlpha()

      • getPremultiplyAlpha

        public boolean getPremultiplyAlpha()
        Get whether to premultiply the alpha channel.
        Returns:
        true to premultiply the alpha
        See Also:
        setPremultiplyAlpha(boolean)

      • filter

        public java.awt.image.BufferedImage filter​(java.awt.image.BufferedImage src,
                                           java.awt.image.BufferedImage dst)
        Specified by:
        filter in interface java.awt.image.BufferedImageOp

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object