com.sharkysoft.fig.core.doodle

Class TransformedDoodle<DoodleType extends Doodle>

java.lang.Object

com.sharkysoft.fig.core.doodle.ChildDoodle

com.sharkysoft.fig.core.doodle.DoodleDecorator<DoodleType>

com.sharkysoft.fig.core.doodle.TransformedDoodle<DoodleType>

All Implemented Interfaces:

DefaultOriginDoodle, Doodle, LocationDoodle, ParentDoodle

public class TransformedDoodle<DoodleType extends Doodle>
extends DoodleDecorator<DoodleType>
implements LocationDoodle

Transforms Doodle.

Details: TransformedDoodle allows you to place a Doodle at any location and draw it at any scale or rotation. Four properties govern the transformation of the original Doodle:

• Origin
• Location
• Rotation
• ScaleX
• ScaleY

Rotation is the amount that the original Doodle is rotated. ScaleX and ScaleY are the amounts that the original Doodle is scaled in the X and Y direction, respectively. Origin is the point in the original Doodle about which the Doodle is scaled and rotated, and it is also the point in the original Doodle that appears at the TransformedDoodle's location. In other words, when the transformed Doodle's Location is set to a new value, it is the original Doodle's origin that is translated to this point.

Author:

Sharky

Field Summary

Fields

Modifier and Type	Field and Description
protected Point2D	mLocation
protected Point2D	mOrigin
protected double	mRotationRadians
protected double	mScaleX
protected double	mScaleY

Fields inherited from class com.sharkysoft.fig.core.doodle.DoodleDecorator

mDoodle

Fields inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

mParent

Constructor Summary

Constructors

Constructor and Description
TransformedDoodle(DoodleType iDoodle)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(AffineTransform iTransform, Point2D iPoint) Tests point for contact with doodle.
static <DoodleType extends Doodle> TransformedDoodle<DoodleType>	createCentered(DoodleType iDoodle) Centers origin in new instance.
boolean	draw(FigGraphics iG) Renders doodle.
Rectangle2D	getBounds(AffineTransform iTransform, Rectangle2D oBounds) Returns rectangular extent.
Point2D	getLocation()
Point2D	getOrigin()
double	getRotationDegrees()
double	getRotationRadians()
double	getScaleX()
double	getScaleY()
protected AffineTransform	getTransform()
void	setLocation(Point2D iLocation)
void	setOrigin(Point2D iOrigin)
void	setRotationDegrees(double iRotationDegrees)
void	setRotationRadians(double iRotationRadians)
void	setScale(double iScale)
void	setScaleX(double iScaleX)
void	setScaleY(double iScaleY)

Methods inherited from class com.sharkysoft.fig.core.doodle.DoodleDecorator

getDoodle, getZOrder, hasDescendant, sendDoodleChanged

Methods inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

getDefaultOrigin, getParent, redraw, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sharkysoft.fig.core.doodle.Doodle

setParent

Field Detail

mOrigin

protected Point2D mOrigin

mLocation

protected Point2D mLocation

mRotationRadians

protected double mRotationRadians

mScaleX

protected double mScaleX

mScaleY

protected double mScaleY

Constructor Detail

TransformedDoodle

public TransformedDoodle(DoodleType iDoodle)

Method Detail

getOrigin

public Point2D getOrigin()

Specified by:

getOrigin in interface LocationDoodle

setOrigin

public void setOrigin(Point2D iOrigin)

Specified by:

setOrigin in interface LocationDoodle

getLocation

public Point2D getLocation()

Specified by:

getLocation in interface LocationDoodle

setLocation

public void setLocation(Point2D iLocation)

Specified by:

setLocation in interface LocationDoodle

getRotationRadians

public double getRotationRadians()

setRotationRadians

public void setRotationRadians(double iRotationRadians)

getRotationDegrees

public double getRotationDegrees()

setRotationDegrees

public void setRotationDegrees(double iRotationDegrees)

getScaleX

public double getScaleX()

setScaleX

public void setScaleX(double iScaleX)

getScaleY

public double getScaleY()

setScaleY

public void setScaleY(double iScaleY)

setScale

public void setScale(double iScale)

getTransform

protected AffineTransform getTransform()

draw

public boolean draw(FigGraphics iG)

Description copied from interface: Doodle

Renders doodle.

Details: Doodle.draw(FigGraphics) renders this doodle using the supplied graphics environment. When the host FigureView is repainting itself, it will probably call this method, albeit indirectly, to redraw its figure's components. This method returns true if drawing was successful, false otherwise.

Specified by:

draw in interface Doodle

Overrides:

draw in class DoodleDecorator<DoodleType extends Doodle>

Parameters:

iG - the graphics context

Returns:

true iff drawing was successful

getBounds

public Rectangle2D getBounds(AffineTransform iTransform,
                    Rectangle2D oBounds)

Description copied from interface: Doodle

Returns rectangular extent.

Details: This method returns the rectangular extent of this Doodle. The rectangle returned is in logical (i.e. figure) units, not display units.

A provided AffineTransformreveals the characteristics of the viewing context in which the bounds will be considered. This information is meaningful only in Doodles that alter their logical form to accommodate the view, such as ViewDoodle. Most implementations will simply ignore this transform, and in some cases, this transform may be null, indicating that the transform is a "don't- care." Regardless of the transform provided, the rectangle returned must be in figure coordinates, not view coordinates.

Optionally, the caller may pass in a pre-existing rectangle and have it re-initialized with the result. If the provided rectangle is null, a new rectangle will be instantiated, initialized with the result, and returned. In either case, the rectangle containing the result is returned.

Specified by:

getBounds in interface Doodle

Overrides:

getBounds in class DoodleDecorator<DoodleType extends Doodle>

Parameters:

iTransform - the current viewing transform

oBounds - destination for result

Returns:

the extent

createCentered

public static <DoodleType extends Doodle> TransformedDoodle<DoodleType> createCentered(DoodleType iDoodle)

Centers origin in new instance.

Details: createCentered instantiates a new TransformedDoodle with the origin set to the original Doodle's center.

Parameters:

iDoodle - the Doodle to decorate

Returns:

the constructed Doodle

contains

public boolean contains(AffineTransform iTransform,
               Point2D iPoint)

Description copied from interface: Doodle

Tests point for contact with doodle.

Details: Doodle.contains(AffineTransform, Point2D) returns true if the given point lies on this doodle, false otherwise.

A provided AffineTransform reveals the characteristics of the view where containment is being tested. This is useful only for Doodles that alter their logical form in order to accommodate the view. Most implementations will simply ignore this transform, and in some cases, this transform may be null, indicating that the transform is not to be considered. In any case, the point being tested is already in figure coordinates.

Specified by:

contains in interface Doodle

Overrides:

contains in class DoodleDecorator<DoodleType extends Doodle>

Parameters:

iTransform - current viewing transform

iPoint - point to test

Returns:

true iff point hits shape