icy.plugin.interface_

Interface PluginROI

All Superinterfaces:

PluginNoEDTConstructor

All Known Implementing Classes:

ROI2DAreaPlugin, ROI2DEllipsePlugin, ROI2DLinePlugin, ROI2DPointPlugin, ROI2DPolygonPlugin, ROI2DPolyLinePlugin, ROI2DRectanglePlugin, ROI3DLinePlugin, ROI3DPointPlugin, ROI3DPolyLinePlugin, ROILineCutterPlugin

public interface PluginROI
extends PluginNoEDTConstructor

Plugin ROI interface.
Used to define a plugin representing a specific ROI.
The plugin will appears in the ROI list.

Author:

Fab & Stephane

Method Summary

Methods

Modifier and Type	Method and Description
ROI	createROI() Create and return a new ROI.
ROI	createROI(Point5D pt) Create and return a new ROI for interactive mode.
java.lang.String	getROIClassName() Return the ROI class name (ROIClass.getClassName())

Method Detail

getROIClassName

java.lang.String getROIClassName()

Return the ROI class name (ROIClass.getClassName())

createROI

ROI createROI(Point5D pt)

Create and return a new ROI for interactive mode.
The first point will be created in selected state so will support direct drag operation.

Parameters:

pt - location of the creation point

Returns:

the new created ROI

createROI

ROI createROI()

Create and return a new ROI.
Default constructor.

Returns:

the new created ROI