com.myscript.iink

Class Renderer

java.lang.Object

com.myscript.iink.Renderer

All Implemented Interfaces:

IAutoCloseable

public class Renderer
extends java.lang.Object
implements IAutoCloseable

The Renderer implements content rendering of parts.

Method Summary

Modifier and Type	Method and Description
void	addListener(IRendererListener listener) Adds the specified listener to this renderer.
void	close() Deletes native counterpart of this auto closable object
void	commitModelDraw(long id) Indicates that an asynchronous drawing of the Model Layer is over.
void	drawBackground(int x, int y, int width, int height, ICanvas canvas) Requests drawing of a region of the Background layer.
void	drawCaptureStrokes(int x, int y, int width, int height, ICanvas canvas) Requests drawing of a region of the Capture layer.
void	drawModel(int x, int y, int width, int height, ICanvas canvas) Requests drawing of a region of the Model layer.
long	drawModelAsync(int x, int y, int width, int height, ICanvas canvas) Requests asynchronous drawing of a region of the Model layer.
void	drawTemporaryItems(int x, int y, int width, int height, ICanvas canvas) Requests drawing of a region of the Temporary layer.
float	getDpiX() Returns the horizontal DPI resolution of the renderer.
float	getDpiY() Returns the vertical DPI resolution of the renderer.
float	getPixelSize() Returns the size of a pixel, in millimeters.
IRenderTarget	getRenderTarget() Returns the target to which this renderer draws.
Point	getViewOffset() Returns the view offset.
float	getViewScale() Returns the current zoom view scale.
Transform	getViewTransform() Returns the transform that is used to map model coordinates into view coordinates.
boolean	isClosed() Tells whether the close() method has been called.
void	registerStroker(java.lang.String name, IStrokerFactory factory) Registers a custom stroker factory.
void	removeListener(IRendererListener listener) Removes the specified listener from this renderer.
void	setViewOffset(float x, float y) Sets the view offset.
void	setViewScale(float scale) Sets the current zoom view scale.
void	unregisterStroker(java.lang.String name) Unregister custom stroker factory.
void	zoom(float factor) Increase zoom by a factor.
void	zoomAt(Point p, float factor) Increase zoom by a factor around a given point.

Methods inherited from class java.lang.Object

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

Method Detail

close

public final void close()

Description copied from interface: IAutoCloseable

Deletes native counterpart of this auto closable object

Specified by:

close in interface IAutoCloseable

isClosed

public final boolean isClosed()

Tells whether the close() method has been called. Once an object is closed any method will throw IllegalStateException.

Returns:

true if this object is closed.

addListener

public final void addListener(IRendererListener listener)

Adds the specified listener to this renderer.

Parameters:

listener - the listener to be added.

Throws:

java.lang.IllegalStateException - when this editor is closed.

java.lang.IllegalArgumentException - when `listener` is null.

removeListener

public final void removeListener(IRendererListener listener)

Removes the specified listener from this renderer.

Parameters:

listener - the listener to be removed.

Throws:

java.lang.IllegalStateException - when this editor is closed.

java.lang.IllegalArgumentException - when `listener` is null.

getDpiX

public float getDpiX()

Returns the horizontal DPI resolution of the renderer.

Returns:

the horizontal DPI.

getDpiY

public float getDpiY()

Returns the vertical DPI resolution of the renderer.

Returns:

the vertical DPI.

getPixelSize

public float getPixelSize()

Returns the size of a pixel, in millimeters.

Returns:

the size of a pixel.

getViewScale

public final float getViewScale()

Returns the current zoom view scale.

Returns:

the view scale.

setViewScale

public final void setViewScale(float scale)
                        throws java.lang.IllegalArgumentException

Sets the current zoom view scale.

Parameters:

scale - the view scale.

Throws:

java.lang.IllegalArgumentException - when `scale` is not a number.

java.lang.IllegalArgumentException - when `scale` is negative.

java.lang.IllegalArgumentException - when `scale` is zero.

zoom

public final void zoom(float factor)
                throws java.lang.IllegalArgumentException

Increase zoom by a factor.

Parameters:

factor - the zoom modification factor.

Throws:

java.lang.IllegalArgumentException - when `factor` is not a number.

java.lang.IllegalArgumentException - when `factor` is negative.

java.lang.IllegalArgumentException - when `factor` is zero.

zoomAt

public final void zoomAt(Point p,
                         float factor)
                  throws java.lang.IllegalArgumentException

Increase zoom by a factor around a given point.

Parameters:

p - point around which to adjust the view.

factor - the zoom modification factor.

Throws:

java.lang.IllegalArgumentException - when `factor` is not a number.

java.lang.IllegalArgumentException - when `factor` is negative.

java.lang.IllegalArgumentException - when `factor` is zero.

getViewOffset

public final Point getViewOffset()

Returns the view offset.

Returns:

the view offset.

setViewOffset

public final void setViewOffset(float x,
                                float y)

Sets the view offset.

Parameters:

x - the x coordinate of the view offset.

y - the y coordinate of the view offset.

Throws:

java.lang.IllegalArgumentException - when `x` is not a number.

java.lang.IllegalArgumentException - when `x` is negative.

java.lang.IllegalArgumentException - when `x` is zero.

java.lang.IllegalArgumentException - when `y` is not a number.

java.lang.IllegalArgumentException - when `y` is negative.

java.lang.IllegalArgumentException - when `y` is zero.

getViewTransform

public Transform getViewTransform()

Returns the transform that is used to map model coordinates into view coordinates.

Returns:

the view transform.

getRenderTarget

public IRenderTarget getRenderTarget()

Returns the target to which this renderer draws.

Returns:

the render target.

registerStroker

public final void registerStroker(java.lang.String name,
                                  IStrokerFactory factory)

Registers a custom stroker factory.

Parameters:

name - the value of the -myscript-pen-brush css property that selects this stroker.

factory - the user provided stroker factory.

Throws:

java.lang.IllegalArgumentException - when `factory` is null.

unregisterStroker

public final void unregisterStroker(java.lang.String name)

Unregister custom stroker factory.

Parameters:

name - the stroker factory.

drawModelAsync

public final long drawModelAsync(int x,
                                 int y,
                                 int width,
                                 int height,
                                 ICanvas canvas)

Requests asynchronous drawing of a region of the Model layer. Completion of the drawing operation must be indicated by a call to commitModelDraw().

Parameters:

x - top left x coordinate of the region to draw.

y - top left y coordinate of the region to draw.

width - width of the region to draw.

height - height of the region to draw.

canvas - target canvas.

Returns:

the identifier of the drawing request.

Throws:

java.lang.IllegalArgumentException - when `canvas` is null.

commitModelDraw

public final void commitModelDraw(long id)

Indicates that an asynchronous drawing of the Model Layer is over.

Parameters:

id - the identifier of the drawing request, as returned by drawModelAsync().

drawBackground

public final void drawBackground(int x,
                                 int y,
                                 int width,
                                 int height,
                                 ICanvas canvas)

Requests drawing of a region of the Background layer.

Parameters:

x - top left x coordinate of the region to draw.

y - top left y coordinate of the region to draw.

width - width of the region to draw.

height - height of the region to draw.

canvas - target canvas.

Throws:

java.lang.IllegalArgumentException - when `canvas` is null.

drawModel

public final void drawModel(int x,
                            int y,
                            int width,
                            int height,
                            ICanvas canvas)

Requests drawing of a region of the Model layer.

Parameters:

x - top left x coordinate of the region to draw.

y - top left y coordinate of the region to draw.

width - width of the region to draw.

height - height of the region to draw.

canvas - target canvas.

Throws:

java.lang.IllegalArgumentException - when `canvas` is null.

drawTemporaryItems

public final void drawTemporaryItems(int x,
                                     int y,
                                     int width,
                                     int height,
                                     ICanvas canvas)

Requests drawing of a region of the Temporary layer.

Parameters:

x - top left x coordinate of the region to draw.

y - top left y coordinate of the region to draw.

width - width of the region to draw.

height - height of the region to draw.

canvas - target canvas.

Throws:

java.lang.IllegalArgumentException - when `canvas` is null.

drawCaptureStrokes

public final void drawCaptureStrokes(int x,
                                     int y,
                                     int width,
                                     int height,
                                     ICanvas canvas)

Requests drawing of a region of the Capture layer.

Parameters:

x - top left x coordinate of the region to draw.

y - top left y coordinate of the region to draw.

width - width of the region to draw.

height - height of the region to draw.

canvas - target canvas.

Throws:

java.lang.IllegalArgumentException - when `canvas` is null.