com.aspose.words
Class ShapeRenderer

java.lang.Object
    com.aspose.words.ShapeRenderer

public class ShapeRenderer 
extends java.lang.Object

ShapeRenderer

public ShapeRenderer(ShapeBase shape)
              throws java.lang.Exception

Initializes a new instance of this class.

Parameters:

shape - The DrawinML shape object that you want to render.

public java.awt.geom.Rectangle2D.Float getOpaqueBoundsInPoints()

Gets the opaque bounds of the shape in points.

This property returns the opaque (i.e. transparent parts of the shape are ignored) bounding box of the shape. The bounds takes the shape rotation into account.

public java.awt.Dimension getSizeInPoints()

Gets the actual size of the shape in points.

This property returns the size of the actual (as rendered on the page) bounding box of the shape. The size takes into account shape rotation (if any).

public java.awt.Rectangle getOpaqueRectangleInPixels(float scale, float dpi)
                                    throws java.lang.Exception

Calculates the opaque rectangle of the shape in pixels for a specified zoom factor and resolution.

This method converts OpaqueBoundsInPoints into rectangle in pixels and it is useful when you want to create a bitmap for rendering the shape with only opaque part of the shape.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution to convert from points to pixels (dots per inch).

Returns:

The opaque rectangle of the shape in pixels.

public java.awt.Dimension getSizeInPixels(float scale, float dpi)

Calculates the size of the shape in pixels for a specified zoom factor and resolution.

This method converts SizeInPoints into size in pixels and it is useful when you want to create a bitmap for rendering the shape neatly onto the bitmap.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution to convert from points to pixels (dots per inch).

Returns:

The size of the shape in pixels.

public java.awt.geom.Point2D.Float renderToScale(java.awt.Graphics2D graphics, float x, float y, float scale)
                   throws java.lang.Exception

Renders the shape into a java.awt.Graphics2D object to a specified scale.

Parameters:

graphics - The object where to render to.

x - The X coordinate (in world units) of the top left corner of the rendered shape.

y - The Y coordinate (in world units) of the top left corner of the rendered shape.

scale - The scale for rendering the shape (1.0 is 100%).

Returns:

The width and height (in world units) of the rendered shape.

public float renderToSize(java.awt.Graphics2D graphics, float x, float y, float width, float height)
                  throws java.lang.Exception

Renders the shape into a java.awt.Graphics2D object to a specified size.

Parameters:

graphics - The object where to render to.

x - The X coordinate (in world units) of the top left corner of the rendered shape.

y - The Y coordinate (in world units) of the top left corner of the rendered shape.

width - The maximum width (in world units) that can be occupied by the rendered shape.

height - The maximum height (in world units) that can be occupied by the rendered shape.

Returns:

The scale that was automatically calculated for the rendered shape to fit the specified size.

public void save(java.io.OutputStream stream, ImageSaveOptions saveOptions)
         throws java.lang.Exception

Renders the shape into an image and saves into a stream.

Parameters:

stream - The stream where to save the image of the shape.

saveOptions - Specifies the options that control how the shape is rendered and saved. Can be null. If this is null, the image will be saved in the PNG format.

public void save(java.lang.String fileName, ImageSaveOptions saveOptions)
         throws java.lang.Exception

Renders the shape into an image and saves into a file.

Parameters:

fileName - The name for the image file. If a file with the specified name already exists, the existing file is overwritten.

saveOptions - Specifies the options that control how the shape is rendered and saved. Can be null.