001/*
002 * Copyright 2010-2015 Institut Pasteur.
003 * 
004 * This file is part of Icy.
005 * 
006 * Icy is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 * 
011 * Icy is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014 * GNU General Public License for more details.
015 * 
016 * You should have received a copy of the GNU General Public License
017 * along with Icy. If not, see <http://www.gnu.org/licenses/>.
018 */
019package icy.plugin.interface_;
020
021import icy.roi.ROI;
022import icy.type.point.Point5D;
023
024/**
025 * Plugin ROI interface.<br>
026 * Used to define a plugin representing a specific ROI.<br>
027 * The plugin will appears in the ROI list.<br>
028 * 
029 * @author Fab & Stephane
030 */
031public interface PluginROI extends PluginNoEDTConstructor
032{
033    /**
034     * Return the ROI class name (ROIClass.getClassName())
035     */
036    public String getROIClassName();
037
038    /**
039     * Create and return a new ROI for <i>interactive</i> mode.<br>
040     * The first point will be created in <i>selected</i> state so will support direct drag
041     * operation.
042     * 
043     * @param pt
044     *        location of the creation point
045     * @return the new created ROI
046     */
047    public ROI createROI(Point5D pt);
048
049    /**
050     * Create and return a new ROI.<br>
051     * Default constructor.
052     * 
053     * @return the new created ROI
054     */
055    public ROI createROI();
056}