/*
 * @(#)Constrainer.java
 *
 * Copyright (c) 1996-2010 by the original authors of JHotDraw and all its
 * contributors. All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the 
 * license agreement you entered into with the copyright holders. For details
 * see accompanying license terms.
 */
package org.jhotdraw.draw;

import java.awt.*;
import java.awt.geom.*;
import javax.swing.event.ChangeListener;

/**
 * A constrainer constrains editing operations performed by
 * {@link org.jhotdraw.draw.tool.Tool}s and
 * {@link org.jhotdraw.draw.handle.Handle}s on a {@link DrawingView}.
 * 

* {@code Constrainer} objects are associated to {@code DrawingView}'s. *

* Constrainers can draw themselves onto the drawing view to visualize the * constraints that they impose. Typically by drawing a grid of some kind. * *


* Design Patterns * *

Strategy
* Editing can be constrained by a constrainer which is associated to a * drawing view.
* Context: {@link DrawingView}; Strategy: {@link Constrainer}. *


* * @author Werner Randelshofer * @version $Id: Constrainer.java 717 2010-11-21 12:30:57Z rawcoder $ */ public interface Constrainer { /** * Constrains the placement of a point towards the closest constraint * in any direction. *

* This method changes the point which is passed as a parameter. * * @param p A point on the drawing. * @return Returns the constrained point. */ public Point2D.Double constrainPoint(Point2D.Double p); /** * Moves a point to the closest constrained location in the specified * direction. *

* This method changes the point which is passed as a parameter. * * @param p A point on the drawing. * @param dir A direction. * @return Returns the constrained point. */ public Point2D.Double translatePoint(Point2D.Double p, TranslationDirection dir); /** * Constrains the placement of a rectangle towards the closest constrainment * in any direction. *

* This method changes the location of the rectangle which is passed as a * parameter. This method does not change the size of the rectangle. * * @param r A rectangle on the drawing. * @return Returns the constrained rectangle. */ public Rectangle2D.Double constrainRectangle(Rectangle2D.Double r); /** * Moves a rectangle to the closest constrained location in the * specified direction. *

* This method changes the location of the rectangle which is passed as a * parameter. This method only performs a translation - it does not change * the size of the rectangle. * * @param r A rectangle on the drawing. * @param dir A direction. * @return Returns the constrained rectangle. */ public Rectangle2D.Double translateRectangle(Rectangle2D.Double r, TranslationDirection dir); /** * Constrains the given angle (in radians). * This method changes the angle which is passed as a parameter. * * @param angle The angle (in radians). * @return The closest constrained angle (in radians). */ public double constrainAngle(double angle); /** * Moves the given angle (in radians) to the closest constrained orientation * in the specified direction. * * @param angle The angle (in radians). * @return The closest constrained angle (in radians) in the specified * direction. */ public double rotateAngle(double angle, RotationDirection dir); /** * Draws the constrainer grid for the specified drawing view. */ public void draw(Graphics2D g, DrawingView view); /** * Adds a change listener. */ public void addChangeListener(ChangeListener listener); /** * Removes a change listener. */ public void removeChangeListener(ChangeListener listener); }

Ads help maintain this website.