jdk.awt.image.renderable.RenderableImageOp — clojure-interop/java.awt 1.0.5

This class handles the renderable aspects of an operation with help from its associated instance of a ContextualRenderedImageFactory.

->renderable-image-op clj

(->renderable-image-op crif param-block)

Constructor.

Constructs a RenderedImageOp given a ContextualRenderedImageFactory object, and a ParameterBlock containing RenderableImage sources and other parameters. Any RenderedImage sources referenced by the ParameterBlock will be ignored.

crif - a ContextualRenderedImageFactory object - java.awt.image.renderable.ContextualRenderedImageFactory param-block - a ParameterBlock containing this operation's source images and other parameters necessary for the operation to run. - java.awt.image.renderable.ParameterBlock

create-default-rendering clj

(create-default-rendering this)

Gets a RenderedImage instance of this image with a default width and height in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in. Implementors of this interface must be sure that there is a defined default width and height.

returns: a RenderedImage containing the rendered data. - java.awt.image.RenderedImage

create-rendering clj

(create-rendering this render-context)

Creates a RenderedImage which represents this RenderableImageOp (including its Renderable sources) rendered according to the given RenderContext.

This method supports chaining of either Renderable or RenderedImage operations. If sources in the ParameterBlock used to construct the RenderableImageOp are RenderableImages, then a three step process is followed:

mapRenderContext() is called on the associated CRIF for each RenderableImage source; createRendering() is called on each of the RenderableImage sources using the backwards-mapped RenderContexts obtained in step 1, resulting in a rendering of each source; ContextualRenderedImageFactory.create() is called with a new ParameterBlock containing the parameters of the RenderableImageOp and the RenderedImages that were created by the createRendering() calls.

If the elements of the source Vector of the ParameterBlock used to construct the RenderableImageOp are instances of RenderedImage, then the CRIF.create() method is called immediately using the original ParameterBlock. This provides a basis case for the recursion.

The created RenderedImage may have a property identified by the String HINTS_OBSERVED to indicate which RenderingHints (from the RenderContext) were used to create the image. In addition any RenderedImages that are obtained via the getSources() method on the created RenderedImage may have such a property.

render-context - The RenderContext to use to perform the rendering. - java.awt.image.renderable.RenderContext

returns: a RenderedImage containing the desired output image. - java.awt.image.RenderedImage

create-scaled-rendering clj

(create-scaled-rendering this w h hints)

Creates a RenderedImage instance of this image with width w, and height h in pixels. The RenderContext is built automatically with an appropriate usr2dev transform and an area of interest of the full image. All the rendering hints come from hints passed in.

If w == 0, it will be taken to equal Math.round(h*(getWidth()/getHeight())). Similarly, if h == 0, it will be taken to equal Math.round(w*(getHeight()/getWidth())). One of w or h must be non-zero or else an IllegalArgumentException will be thrown.

The created RenderedImage may have a property identified by the String HINTS_OBSERVED to indicate which RenderingHints were used to create the image. In addition any RenderedImages that are obtained via the getSources() method on the created RenderedImage may have such a property.

w - the width of rendered image in pixels, or 0. - int h - the height of rendered image in pixels, or 0. - int hints - a RenderingHints object containing hints. - java.awt.RenderingHints

returns: a RenderedImage containing the rendered data. - java.awt.image.RenderedImage

dynamic? clj

(dynamic? this)

Returns true if successive renderings (that is, calls to createRendering() or createScaledRendering()) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. The CRIF's isDynamic method will be called.

returns: true if successive renderings with the same arguments might produce different results; false otherwise. - boolean

get-height clj

(get-height this)

Gets the height in user coordinate space. By convention, the usual height of a RenderedImage is equal to 1.0F.

returns: the height of the image in user coordinates. - float

get-min-x clj

(get-min-x this)

Gets the minimum X coordinate of the rendering-independent image data.

returns: the minimum X coordinate of the rendering-independent image data. - float

get-min-y clj

(get-min-y this)

Gets the minimum Y coordinate of the rendering-independent image data.

returns: the minimum Y coordinate of the rendering-independent image data. - float

get-parameter-block clj

(get-parameter-block this)

Returns a reference to the current parameter block.

returns: the ParameterBlock of this RenderableImageOp. - java.awt.image.renderable.ParameterBlock

get-property clj

(get-property this name)

Gets a property from the property set of this image. If the property name is not recognized, java.awt.Image.UndefinedProperty will be returned.

name - the name of the property to get, as a String. - java.lang.String

returns: a reference to the property Object, or the value java.awt.Image.UndefinedProperty. - java.lang.Object

get-property-names clj

(get-property-names this)

Return a list of names recognized by getProperty.

returns: a list of property names. - java.lang.String[]

get-sources clj

(get-sources this)

Returns a vector of RenderableImages that are the sources of image data for this RenderableImage. Note that this method may return an empty vector, to indicate that the image has no sources, or null, to indicate that no information is available.

returns: a (possibly empty) Vector of RenderableImages, or null. - java.util.Vector<java.awt.image.renderable.RenderableImage>

get-width clj

(get-width this)

Gets the width in user coordinate space. By convention, the usual width of a RenderableImage is equal to the image's aspect ratio (width divided by height).

returns: the width of the image in user coordinates. - float

set-parameter-block clj

(set-parameter-block this param-block)

Change the current ParameterBlock of the operation, allowing editing of image rendering chains. The effects of such a change will be visible when a new rendering is created from this RenderableImageOp or any dependent RenderableImageOp.

param-block - the new ParameterBlock. - java.awt.image.renderable.ParameterBlock

returns: the old ParameterBlock. - java.awt.image.renderable.ParameterBlock