plugins.kernel.roi.roi2d

Class ROI2DRectShape

java.lang.Object

icy.roi.ROI

icy.roi.ROI2D

plugins.kernel.roi.roi2d.ROI2DShape

plugins.kernel.roi.roi2d.ROI2DRectShape

All Implemented Interfaces:

ChangeListener, XMLPersistent, java.awt.Shape

Direct Known Subclasses:

ROI2DEllipse, ROI2DRectangle, ROI2DRectShape

public abstract class ROI2DRectShape
extends ROI2DShape

Base class for rectangular shape ROI.

Author:

Stephane

Nested Class Summary

Nested classes/interfaces inherited from class plugins.kernel.roi.roi2d.ROI2DShape

ROI2DShape.ROI2DShapePainter

Nested classes/interfaces inherited from class icy.roi.ROI2D

ROI2D.ROI2DPainter

Nested classes/interfaces inherited from class icy.roi.ROI

ROI.ROIGroupId, ROI.ROIIdComparator, ROI.ROINameComparator, ROI.ROIPainter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_BOTTOMRIGHT
static java.lang.String	ID_TOPLEFT

Fields inherited from class icy.roi.ROI2D

ID_C, ID_T, ID_Z

Fields inherited from class icy.roi.ROI

DEFAULT_COLOR, DEFAULT_NORMAL_COLOR, DEFAULT_OPACITY, DEFAULT_STROKE, defaultColor, defaultOpacity, defaultShowName, defaultStroke, ID_CLASSNAME, ID_COLOR, ID_GROUPID, ID_ID, ID_NAME, ID_OPACITY, ID_PROPERTIES, ID_READONLY, ID_ROI, ID_SELECTED, ID_SHOWNAME, ID_STROKE, idComparator, nameComparator, PROPERTY_COLOR, PROPERTY_CREATING, PROPERTY_GROUPID, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_OPACITY, PROPERTY_READONLY, PROPERTY_SHOWNAME, PROPERTY_STROKE, ROI_CHANGED_ALL, ROI_CHANGED_POSITION

Constructor Summary

Constructors

Constructor and Description
ROI2DRectShape(java.awt.geom.RectangularShape shape, java.awt.geom.Point2D topLeft, java.awt.geom.Point2D bottomRight)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAddPoint() Return true if this ROI support adding new point
boolean	canRemovePoint() Return true if this ROI support removing point
boolean	canSetBounds() Returns true if this ROI accepts bounds change through the ROI.setBounds5D(Rectangle5D) method.
void	controlPointPositionChanged(Anchor2D source) Called when anchor position changed
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setBounds2D(java.awt.geom.Rectangle2D bounds) Set the ROI 2D bounds.
void	translate(double dx, double dy) Translate the ROI position by the specified delta X/Y.

Methods inherited from class plugins.kernel.roi.roi2d.ROI2DShape

addNewPoint, addNewPoint, addPoint, addPoint, addPointAt, canTranslate, computeBounds2D, computeNumberOfContourPoints, contains, contains, contains, contains, controlPointOverlayChanged, getBooleanMask, getControlPoints, getDefaultName, getExclusiveUnion, getIntersection, getLength, getPathIterator, getPathIterator, getPoints, getShape, getSubtraction, getUnion, hasSelectedPoint, intersects, intersects, isOverEdge, onChanged, painterChanged, removePoint, removePointAt, removeSelectedPoint, unselectAllPoints

Methods inherited from class icy.roi.ROI2D

canSetPosition, computeBounds5D, computeNumberOfPoints, computePerimeter, contains, contains, contains, getArea, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask2D, getBooleanMask2D, getBounds, getBounds2D, getC, getDimension, getPerimeter, getPerimeter, getPosition, getPosition2D, getROI2DList, getROI2DList, getROI2DList, getSubROI, getT, getZ, intersects, intersects, isActiveFor, isActiveFor, isOver, isOver, isOverEdge, isOverEdge, isOverEdge, merge, setBounds5D, setC, setPosition, setPosition2D, setPosition5D, setT, setZ, substract, subtract

Methods inherited from class icy.roi.ROI

add, addListener, attachTo, beginUpdate, canvasToImageDeltaX, canvasToImageDeltaY, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, contains, contains, copyFrom, create, create, create, create, createFromXML, delete, delete, detachFrom, detachFromAll, detachFromAll, endUpdate, exclusiveAdd, focusChanged, getAdjustedStroke, getAdjustedStroke, getBooleanMask2D, getBounds5D, getClassName, getColor, getCopy, getDefaultColor, getDefaultOpacity, getDefaultShowName, getDefaultStroke, getDisplayColor, getFirstSequence, getFocusedColor, getGroupId, getIcon, getId, getName, getNameSuffix, getNumberOfContourPoints, getNumberOfPoints, getOpacity, getOverlay, getPainter, getPosition5D, getProperties, getProperty, getPropertyValue, getROICount, getROIList, getROIList, getROIList, getROIsFromXML, getSelectedColor, getSequences, getShowName, getSimpleClassName, getStroke, getVolume, internalFocus, internalSelect, internalUnfocus, internalUnselect, intersect, intersects, isAttached, isCreating, isDefaultName, isEditable, isEmpty, isFocused, isReadOnly, isSelected, isUpdating, loadFromXML, loadROIsFromXML, merge, mergeWith, nameChanged, painterChanged, propertyChanged, remove, remove, removeListener, roiChanged, roiChanged, roiChanged, saveROIsToXML, selectionChanged, setColor, setCreating, setDefaultColor, setDefaultOpacity, setDefaultShowName, setDefaultStroke, setEditable, setFocused, setGroupId, setIcon, setMousePos, setName, setOpacity, setProperty, setPropertyValue, setReadOnly, setROIsFromXML, setSelected, setSelected, setSelectedColor, setShowName, setStroke, subtract

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.Shape

getBounds, getBounds2D

Field Detail

ID_TOPLEFT

public static final java.lang.String ID_TOPLEFT

See Also:

Constant Field Values

ID_BOTTOMRIGHT

public static final java.lang.String ID_BOTTOMRIGHT

See Also:

Constant Field Values

Constructor Detail

ROI2DRectShape

public ROI2DRectShape(java.awt.geom.RectangularShape shape,
              java.awt.geom.Point2D topLeft,
              java.awt.geom.Point2D bottomRight)

Method Detail

canSetBounds

public boolean canSetBounds()

Description copied from class: ROI

Returns true if this ROI accepts bounds change through the ROI.setBounds5D(Rectangle5D) method.

Overrides:

canSetBounds in class ROI2D

setBounds2D

public void setBounds2D(java.awt.geom.Rectangle2D bounds)

Description copied from class: ROI2D

Set the ROI 2D bounds.
Note that not all ROI supports bounds modification and you should call ROI2D.canSetBounds() first to test if the operation is supported.

Overrides:

setBounds2D in class ROI2D

Parameters:

bounds - new ROI 2D bounds

canAddPoint

public boolean canAddPoint()

Description copied from class: ROI2DShape

Return true if this ROI support adding new point

Overrides:

canAddPoint in class ROI2DShape

canRemovePoint

public boolean canRemovePoint()

Description copied from class: ROI2DShape

Return true if this ROI support removing point

Overrides:

canRemovePoint in class ROI2DShape

controlPointPositionChanged

public void controlPointPositionChanged(Anchor2D source)

Description copied from class: ROI2DShape

Called when anchor position changed

Overrides:

controlPointPositionChanged in class ROI2DShape

translate

public void translate(double dx,
             double dy)

Description copied from class: ROI2D

Translate the ROI position by the specified delta X/Y.
Note that not all ROI support this operation so you should test it by calling ROI2D.canTranslate() first.

Overrides:

translate in class ROI2DShape

Parameters:

dx - translation value to apply on X dimension

dy - translation value to apply on Y dimension

See Also:

ROI2D.canTranslate(), ROI2D.setPosition2D(Point2D)

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

Overrides:

loadFromXML in class ROI2DShape

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

Overrides:

saveToXML in class ROI2D