Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
* A {@code DrawingView} consists of the following layers:
*
*
Background. Displays a background behind the drawing.
*
Drawing. Displays the figures of the drawing.
*
Grid. Displays a grid.
*
Tools. Displays the handles used for editing figures.
*
*
* {@code DrawingView} uses a {@code DrawingModel} to listen for changes on a
* {@code Drawing}. Once a drawing is showing in a drawing view, all changes to
* the drawing must be performed on the drawing model.
*
* {@code DrawingView} invokes {@code validate()} on its {@code DrawingModel}
* each time before it renders the drawing to ensure that the figures are laid
* out and that CSS styles are applied before rendering the drawing.
*
*
* @author Werner Randelshofer
* Responsibility, Handler.
*/
public interface DrawingView extends WritableRenderContext {
// ---
// property names
// ----
/**
* The name of the model property.
*/
String MODEL_PROPERTY = "model";
/**
* The name of the tool property.
*/
String TOOL_PROPERTY = "tool";
/**
* The name of the focused property.
*/
String FOCUSED_PROPERTY = "focused";
/**
* The name of the scale factor property.
*/
String ZOOM_FACTOR_PROPERTY = "zoomFactor";
/**
* The name of the constrainer property.
*/
String CONSTRAINER_PROPERTY = "constrainer";
/**
* The name of the selection property.
*/
String SELECTED_FIGURES_PROPERTY = "selectedFigures";
/**
* The name of the active handle property.
*/
String ACTIVE_HANDLE_PROPERTY = "activeHandle";
/**
* The name of the active layer property.
*/
String ACTIVE_PARENT_PROPERTY = "activeLayer";
/**
* The name of the clipboardInputFormat property.
*/
String CLIPBOARD_INPUT_FORMAT_PROPERTY = "clipboardInputFormat";
/**
* The name of the clibpoardOutputFormat property.
*/
String CLIPBOARD_OUTPUT_FORMAT_PROPERTY = "clibpoardOutputFormat";
/**
* The name of the drawing property.
*/
String DRAWING_PROPERTY = "drawing";
/**
* The name of the editor property.
*/
String EDITOR_PROPERTY = "editor";
// ---
// properties
// ---
/**
* The drawing model.
*
* @return the drawing model property, with {@code getBean()} returning this
* drawing view, and {@code getName()} returning {@code DRAWING_PROPERTY}.
*/
NonNullObjectProperty modelProperty();
/**
* The drawing model.
*
* @return the drawing model property
*/
ReadOnlyObjectProperty drawingProperty();
/**
* The drawing editor.
*
* @return the editor property
*/
ObjectProperty editorProperty();
/**
* The active layer of the drawing.
*
* @return the active layer of the drawing. Returns null if the drawing has
* no layers or no layer has been activated.
*/
ObjectProperty activeParentProperty();
default void scrollSelectedFiguresToVisible() {
final ObservableSet selectedFigures = getSelectedFigures();
if (!selectedFigures.isEmpty()) {
scrollRectToVisible(worldToView(Figures.getBoundsInWorld(selectedFigures)));
}
}
/**
* The tool which currently edits this {@code DrawingView}.
*
* When a tool is set on the drawing view, then drawing view adds the
* {@code Node} of the tool to its tool panel which is stacked on top of the
* drawing panel. It then invokes {@code toolsetDrawingView(this)}.
*
* Setting a tool will removeChild the previous tool. The drawing view
* invokes {@code tool.setDrawingView(null)} and then removes its
* {@code Node} from its tool panel.
*
* @return the tool property, with {@code getBean()} returning this drawing
* view, and {@code getName()} returning {@code TOOL_PROPERTY}.
*/
ObjectProperty toolProperty();
/**
* The scale factor of the drawing view.
*
* @return The zoom factor. The value is always greater than 0. Values
* larger than 1 cause a magnification. Values between 0 and 1 causes a
* minification.
*/
DoubleProperty zoomFactorProperty();
/**
* The constrainer.
*
* @return the constrainer property, with {@code getBean()} returning this
* drawing view, and {@code getName()} returning
* {@code CONSTRAINER_PROPERTY}.
*/
NonNullObjectProperty constrainerProperty();
/**
* The focused property is set to true, when the DrawingView has input
* focus.
*
* @return the focused property, with {@code getBean()} returning this
* drawing view, and {@code getName()} returning {@code FOCUSED_PROPERTY}.
*/
ReadOnlyBooleanProperty focusedProperty();
/**
* The selected figures.
*
* Note: The selection is represented by a {@code SequencedSet} because the
* sequence of the selection is important.
*
* The first figure in the selection is the 'anchor' of the selection.
*
* The last figure in the selection is the 'lead' of the selection.
*
* Operations that act on multiple selected figures, typically use the
* 'lead' figure as the reference figure.
*
* @return the currently selected figures
*/
ReadOnlySetProperty selectedFiguresProperty();
/**
* The handles.
*
* Note: The handles are represented by a {@code SequencedSet} because the
* sequence of the handles is important.
*
* @return the handles that are currently being displayed on this drawing
* view.
*/
ReadOnlySetProperty handlesProperty();
/**
* The active handle.
*
* This is the handle, on which the user has clicked the last time.
*
* Tools that support keyboard input on handles, typically forward keyboard
* input to the active handle.
*
* @return the active handle if present
*/
ObjectProperty activeHandleProperty();
/**
* The clipboard output format.
*
* @return the clipboard output format handle if present
*/
ObjectProperty clipboardOutputFormatProperty();
/**
* The clipboard input format.
*
* @return the clipboard output format handle if present
*/
ObjectProperty clipboardInputFormatProperty();
// ---
// methods
// ---
/**
* Returns the {@code javafx.scene.Node} of the DrawingView.
*
* @return a node
*/
Node getNode();
/**
* Gets the node which is used to render the specified figure by the drawing
* view.
*
* @param f The figure
* @return The node associated to the figure
*/
@Override
@Nullable Node getNode(Figure f);
/**
* Finds the handle at the given view coordinates. Handles are searched in
* Z-order from front to back. Skips handles which are not selectable.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @return A handle or null
*/
@Nullable
Handle findHandle(double vx, double vy);
/**
* Finds the figure at the given view coordinates. Figures are searched in
* Z-order from front to back. Skips disabled figures.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param figures Only searches in the provided list of figures
* @return A figure or null
*/
default @Nullable Figure findFigure(double vx, double vy, Set figures) {
List> result = findFigures(vx, vy, false, figures::contains);
return getClosestFigure(result);
}
default Figure getClosestFigure(List> result) {
double closestDistance = Double.POSITIVE_INFINITY;
Figure closestFigure = null;
for (Map.Entry entry : result) {
if (entry.getValue() < closestDistance) {
closestDistance = entry.getValue();
closestFigure = entry.getKey();
if (closestDistance == 0.0) {
break;
}
}
}
return closestFigure;
}
/**
* Finds the figure at the given view coordinates. Figures are searched in
* Z-order from front to back. Only returns selectable figures.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @return A figure or null
*/
default @Nullable Figure findFigure(double vx, double vy) {
return findFigure(vx, vy, Figure::isSelectable);
}
/**
* Finds the figure at the given view coordinates. Figures are searched in
* Z-order from front to back.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @return A figure or null
*/
default @Nullable Figure findFigure(double vx, double vy, Predicate predicate) {
List> result = findFigures(vx, vy, false, predicate);
return getClosestFigure(result);
}
/**
* Finds the front-most node of the specified figure that contains the
* specified view coordinates.
*
* @param figure the figure
* @param vx x in view coordinates
* @param vy y in view coordinates
* @return A node or null
*/
@Nullable
Node findFigureNode(Figure figure, double vx, double vy);
/**
* Finds the figure at the given view coordinates behind the given figure.
* Figures are searched in Z-order from front to back. Only returns
* figures that are selectable.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back.
* Each entry contains the figure and the distance of the figure to vx,vy.
* Distance 0 means that vx,vy is inside the figure.
*/
default List> findFigures(double vx, double vy, boolean decompose) {
return findFigures(vx, vy, decompose, Figure::isSelectable);
}
/**
* Finds the figure at the given view coordinates behind the given figure.
* Figures are searched in Z-order from front to back.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back.
* Each entry contains the figure and the distance of the figure to vx,vy.
* Distance 0 means that vx,vy is inside the figure.
*/
List> findFigures(double vx, double vy, boolean decompose, Predicate predicate);
/**
* Returns all figures that lie within the specified bounds given in view
* coordinates. The figures are returned in Z-order from back to front.
* Skips disabled figures.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param vwidth width in view coordinates
* @param vheight height in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back.
* Each entry contains the figure and the distance of the figure to vx,vy.
* Distance 0 means that vx,vy is inside the figure.
*/
List> findFiguresInside(double vx, double vy, double vwidth, double vheight, boolean decompose);
/**
* Returns all figures that intersect the specified bounds given in view
* coordinates. The figures are returned in Z-order from front to back.
* Skips disabled figures.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param vwidth width in view coordinates
* @param vheight height in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back
*/
default List> findFiguresIntersecting(double vx, double vy, double vwidth, double vheight, boolean decompose) {
return findFiguresIntersecting(vx, vy, vwidth, vheight, decompose, f -> true);
}
/**
* Returns all figures that intersect the specified bounds given in view
* coordinates. The figures are returned in Z-order from front to back.
* Skips disabled figures.
*
* @param vx x in view coordinates
* @param vy y in view coordinates
* @param vwidth width in view coordinates
* @param vheight height in view coordinates
* @param decompose whether to decompose the figures
* @param predicate predicate for filtering figures
* @return A list of figures from front to back
*/
List> findFiguresIntersecting(double vx, double vy, double vwidth, double vheight, boolean decompose, Predicate predicate);
// Handles
/**
* Gets selected figures with the same handle.
*
* @param figures selected figures
* @param handle a handle
* @return A collection containing the figures with compatible handles.
*/
Set getFiguresWithCompatibleHandle(Collection figures, Handle handle);
/**
* Returns the world to view transformation.
*
* @return the transformation
*/
Transform getWorldToView();
/**
* Returns the view to world transformation.
*
* @return the transformation;
*/
Transform getViewToWorld();
// ---
// convenience methods
// ---
/**
* Finds the figure at the given view coordinates. Figures are searched in
* Z-order from front to back. Skips disabled figures and non-selectable
* figures.
*
* @param pointInView point in view coordinates
* @return A figure or empty
*/
default @Nullable Figure findFigure(Point2D pointInView) {
return findFigure(pointInView.getX(), pointInView.getY());
}
/**
* Finds the figures at the given view coordinates. Figures are searched in
* Z-order from front to back. Skips disabled figures and non-selectable
* figures.
*
* @param pointInView point in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back.
* Each entry contains the figure and the distance of the figure to vx,vy.
* Distance 0 means that pointInView is inside the figure.
*/
default List> findFigures(Point2D pointInView, boolean decompose) {
return findFigures(pointInView.getX(), pointInView.getY(), decompose);
}
/**
* Returns all figures that are inside the specified bounds given in view
* coordinates. The figures are returned in Z-order from front to back.
* Skips disabled figures and non-selectable figures.
*
* @param rectangleInView rectangle in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back.
* Each entry contains the figure and the distance of the figure to vx,vy.
* Distance 0 means that pointInView is inside the figure.
*/
default List> findFiguresInside(Rectangle2D rectangleInView, boolean decompose) {
return findFiguresInside(rectangleInView.getMinX(), rectangleInView.getMinY(), rectangleInView.getWidth(), rectangleInView.getHeight(), decompose);
}
/**
* Returns all figures that intersect the specified bounds given in view
* coordinates. The figures are returned in Z-order from back to front.
* Skips disabled figures and non-selectable figures.
*
* @param rectangleInView rectangle in view coordinates
* @param decompose whether to decompose the figures
* @return A list of figures from front to back
*/
default List> findFiguresIntersecting(Rectangle2D rectangleInView, boolean decompose) {
return findFiguresIntersecting(rectangleInView.getMinX(), rectangleInView.getMinY(), rectangleInView.getWidth(), rectangleInView.getHeight(), decompose, Figure::isSelectable);
}
default void setDrawing(@Nullable Drawing newValue) {
getModel().setRoot(newValue);
setActiveParent(null);
}
default @Nullable Drawing getDrawing() {
return modelProperty().get().getDrawing();
}
default void setEditor(@Nullable DrawingEditor newValue) {
editorProperty().set(newValue);
}
default @Nullable DrawingEditor getEditor() {
return editorProperty().get();
}
default void setConstrainer(Constrainer newValue) {
constrainerProperty().set(newValue);
}
default Constrainer getConstrainer() {
return constrainerProperty().get();
}
default void setTool(@Nullable Tool newValue) {
toolProperty().set(newValue);
}
default @Nullable Tool getTool() {
return toolProperty().get();
}
default void setActiveHandle(@Nullable Handle newValue) {
activeHandleProperty().set(newValue);
}
default @Nullable Handle getActiveHandle() {
return activeHandleProperty().get();
}
default @Nullable Figure getSelectionLead() {
ArrayList selection = new ArrayList<>(getSelectedFigures());
return selection.isEmpty() ? null : selection.getLast();
}
default @Nullable Figure getSelectionAnchor() {
Set selection = getSelectedFigures();
return selection.isEmpty() ? null : selection.iterator().next();
}
default void setActiveParent(@Nullable Figure newValue) {
activeParentProperty().set(newValue);
}
default @Nullable Figure getActiveParent() {
return activeParentProperty().get();
}
default void setZoomFactor(double newValue) {
zoomFactorProperty().set(newValue);
}
default double getZoomFactor() {
return zoomFactorProperty().get();
}
default ObservableSet getSelectedFigures() {
return selectedFiguresProperty().get();
}
default ObservableSet getHandles() {
return handlesProperty().get();
}
/**
* Converts view coordinates into world coordinates.
*
* @param view a point in view coordinates
* @return the corresponding point in world coordinates
*/
default Point2D viewToWorld(Point2D view) {
return FXTransforms.transform(getViewToWorld(), view);
}
/**
* Converts view coordinates into world coordinates.
*
* @param view a rectangle in view coordinates
* @return the corresponding point in world coordinates
*/
default Bounds viewToWorld(Bounds view) {
return getViewToWorld().transform(view);
}
/**
* Converts world coordinates into view coordinates.
*
* @param world a point in world coordinates
* @return the corresponding point in view coordinates
*/
default Point2D worldToView(Point2D world) {
return FXTransforms.transform(getWorldToView(), world);
}
/**
* Converts world coordinates into view coordinates.
*
* @param world a box in world coordinates
* @return the corresponding box in view coordinates
*/
default Bounds worldToView(Bounds world) {
return getWorldToView().transform(world);
}
/**
* Converts view coordinates into world coordinates.
*
* @param vx the x coordinate of a point in view coordinates
* @param vy the y coordinate of a point in view coordinates
* @return the corresponding point in world coordinates
*/
default Point2D viewToWorld(double vx, double vy) {
return getViewToWorld().transform(vx, vy);
}
/**
* Converts world coordinates into view coordinates.
*
* @param dx the x coordinate of a point in world coordinates
* @param dy the y coordinate of a point in world coordinates
* @return the corresponding point in view coordinates
*/
default Point2D worldToView(double dx, double dy) {
return getWorldToView().transform(dx, dy);
}
/**
* Returns the underlying drawing model.
*
* @return a drawing model
*/
default DrawingModel getModel() {
return modelProperty().get();
}
/**
* Sets a new underlying drawing model.
*
* @param newValue a drawing model
*/
default void setModel(DrawingModel newValue) {
modelProperty().set(newValue);
}
default void setClipboardOutputFormat(@Nullable ClipboardOutputFormat newValue) {
clipboardOutputFormatProperty().set(newValue);
}
default void setClipboardInputFormat(@Nullable ClipboardInputFormat newValue) {
clipboardInputFormatProperty().set(newValue);
}
default @Nullable ClipboardOutputFormat getClipboardOutputFormat() {
return clipboardOutputFormatProperty().get();
}
default @Nullable ClipboardInputFormat getClipboardInputFormat() {
return clipboardInputFormatProperty().get();
}
void recreateHandles();
/**
* Plays a short animation on the handles to make them easier discoverable.
*/
void jiggleHandles();
/**
* Scrolls the specified figure to visible.
*
* @param f A figure in the drawing of this DrawingView.
*/
default void scrollFigureToVisible(Figure f) {
Bounds boundsInView = worldToView(f.getLayoutBoundsInWorld());
scrollRectToVisible(boundsInView);
}
/**
* Scrolls the specified rectangle to visible.
*
* @param boundsInView A rectangle in view coordinates.
*/
void scrollRectToVisible(Bounds boundsInView);
/**
* Returns the visible rectangle of the drawing view in view coordinates.
*
* @return the portion of the DrawingView that is visible on screen.
*/
Bounds getVisibleRect();
}
