org.apache.flex.swf.builders

Class ShapeBuilder

java.lang.Object

org.apache.flex.swf.builders.ShapeBuilder

public final class ShapeBuilder
extends Object

A utility class to help construct a SWF Shape from Java2D AWT Shapes. By default, all co-ordinates are coverted to twips (1/20th of a pixel).

Constructor Summary

Constructors

Constructor and Description
ShapeBuilder() Constructor.
ShapeBuilder(boolean useTwips) Constructor.
ShapeBuilder(Styles styles) Constructor.
ShapeBuilder(Styles styles, boolean useTwips) Constructor.
ShapeBuilder(Styles styles, Point origin) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Shape	build()
void	close() Creates a straight-edge record (i.e a straight line) from the current drawing position to the last move-to position.
void	correctRoundingErrors() If a shape is closed then the start and finish records must match exactly to the nearest twip.
void	curved(double cx, double cy, double ax, double ay) Creates a quadratic spline in SWF as a curved-edge record.
static void	divideQuad(double[] src, int srcoff, double[] left, int loff, double[] right, int roff) From java.awt.geom.QuadCurve2D
int	getCurrentFillStyle0() Gets the current fill style index.
int	getCurrentFillStyle1() Gets the current fill style 1 index.
int	getCurrentLineStyle() Gets the current line style index.
static Point	getPointOnSegment(Point P0, Point P1, double ratio) Return a point on a segment [P0, P1] which distance from P0 is ratio of the length [P0, P1]
boolean	getUseFillStyle1() Gets whether the current paint method should include fill style 1 information, which controls how intersecting shape fills are drawn.
void	move(double x, double y) Moves the current pen position to a new location without drawing.
void	processShape(IShapeIterator si) Processes a Shape by converting its general path to a series of ShapeRecords.
void	setCurrentFillStyle0(int index) Sets the current fill style index.
void	setCurrentFillStyle1(int index) Sets the current fill style 1 index.
void	setCurrentLineStyle(int index) Sets the current line style index.
void	setFont12or3(boolean b) Set whether the shape is part of a DefineFont1, DefineFont2 or DefineFont3 tag.
void	setUseFillStyle0(boolean b) Sets the paint method to include fill style 0 information, which is for filling simple shapes.
void	setUseFillStyle1(boolean b) Sets the paint method to include fill style 1 information, which controls how intersecting shape fills are drawn.
void	straight(double x, double y) Calculates the change or 'delta' in position between the current pen location and a given co-ordinate pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeBuilder

public ShapeBuilder()

Constructor.

Creates an empty Flash Shape with the pen starting at [0.0, 0.0].

ShapeBuilder

public ShapeBuilder(boolean useTwips)

Constructor.

Creates an empty Flash Shape with the pen starting at [0.0,0.0].

Parameters:

useTwips - true to convert to twips.

ShapeBuilder

public ShapeBuilder(Styles styles)

Constructor.

Creates an empty Flash Shape with the pen starting at [0.0, 0.0].

ShapeBuilder

public ShapeBuilder(Styles styles,
            boolean useTwips)

Constructor.

Use this constructor to specify whether co-ordinates will be converted to twips (1/20th of a pixel). The default is to use this conversion.

Parameters:

useTwips - true to convert to twips.

ShapeBuilder

public ShapeBuilder(Styles styles,
            Point origin)

Constructor.

Creates an empty Flash Shape. ShapeRecords can be added manually using the process shape method.

Parameters:

origin - the pen starting point, typically [0.0,0.0]

See Also:

processShape(IShapeIterator)

Method Detail

build

public Shape build()

processShape

public void processShape(IShapeIterator si)

Processes a Shape by converting its general path to a series of ShapeRecords. The records are not terminated with an EndShapeRecord so that subsequent calls can be made to this method to concatenate more shape paths.

For closed shapes (including character glyphs) there exists a high possibility of rounding errors caused by the conversion of double-precision pixel co-ordinates to integer twips (1 twip = 1/20th pixel at 72 dpi). As such, at each move command this error is checked and corrected.

Parameters:

si - A IShapeIterator who's path will be converted to records and added to the collection

correctRoundingErrors

public void correctRoundingErrors()

If a shape is closed then the start and finish records must match exactly to the nearest twip. This method attempts to close the shape by adding a StraightEdgeRecord with a delta equal to the accumulated rounding errors, if such errors exists.

move

public void move(double x,
        double y)

Moves the current pen position to a new location without drawing. In SWF, this requires a style change record and a delta is calculated between the current position and the new position.

If fill or line style information has changed since the last move command, the new style information is also included in the record.

Parameters:

x - The new horizontal location.

y - The new vertical location.

straight

public void straight(double x,
            double y)

Calculates the change or 'delta' in position between the current pen location and a given co-ordinate pair. This delta is used to create a straight-edge shape record in SWF, i.e. a simple line.

Parameters:

x - The new horizontal location.

y - The new vertical location.

curved

public void curved(double cx,
          double cy,
          double ax,
          double ay)

Creates a quadratic spline in SWF as a curved-edge record. The current pen position is used as the first anchor point, and is used with the two other points supplied to calculate a delta between the origin and the control point, and the control point and the final anchor point.

Parameters:

cx - - control point-x

cy - - control point-y

ax - - anchor point-x

ay - - anchor point-y

close

public void close()

Creates a straight-edge record (i.e a straight line) from the current drawing position to the last move-to position. If the delta for the x and y co-ordinates is zero, a line is not necessary and the method does nothing.

divideQuad

public static void divideQuad(double[] src,
              int srcoff,
              double[] left,
              int loff,
              double[] right,
              int roff)

From java.awt.geom.QuadCurve2D

setFont12or3

public void setFont12or3(boolean b)

Set whether the shape is part of a DefineFont1, DefineFont2 or DefineFont3 tag.

Parameters:

b - true if shape part of a font tag

getCurrentLineStyle

public int getCurrentLineStyle()

Gets the current line style index. Note that a value of zero represents the empty stroke.

Returns:

index to the current line style in the LineStyleArray

setCurrentLineStyle

public void setCurrentLineStyle(int index)

Sets the current line style index. Note that a value of zero represents the empty stroke.

Parameters:

index - index to a line style in the LineStyleArray

getCurrentFillStyle0

public int getCurrentFillStyle0()

Gets the current fill style index. Note that a value of zero represents a blank fill.

Returns:

index to the current fill style in the FillStyleArray

setCurrentFillStyle0

public void setCurrentFillStyle0(int index)

Sets the current fill style index. Note that a value of zero represents a blank fill.

Parameters:

index - The index of a fill style.

getCurrentFillStyle1

public int getCurrentFillStyle1()

Gets the current fill style 1 index. A fill style 1 record represents the fill of intersecting shape areas. Note that a value of zero represents a blank fill.

Returns:

index to the current fill style in the FillStyleArray

setCurrentFillStyle1

public void setCurrentFillStyle1(int index)

Sets the current fill style 1 index. A fill style 1 record represents the fill of intersecting shape areas. Note that a value of zero represents a blank fill.

Parameters:

index - The index of a fill style.

getUseFillStyle1

public boolean getUseFillStyle1()

Gets whether the current paint method should include fill style 1 information, which controls how intersecting shape fills are drawn.

setUseFillStyle1

public void setUseFillStyle1(boolean b)

Sets the paint method to include fill style 1 information, which controls how intersecting shape fills are drawn.

Parameters:

b - if set to true, fill style 1 information will be used for intersecting shapes

setUseFillStyle0

public void setUseFillStyle0(boolean b)

Sets the paint method to include fill style 0 information, which is for filling simple shapes.

Parameters:

b - if set to true, fill style 0 information will be used for normal shapes

getPointOnSegment

public static Point getPointOnSegment(Point P0,
                      Point P1,
                      double ratio)

Return a point on a segment [P0, P1] which distance from P0 is ratio of the length [P0, P1]