icy.roi

Class ROI.ROIPainter

java.lang.Object

icy.painter.Overlay

icy.roi.ROI.ROIPainter

All Implemented Interfaces:

ChangeListener, XMLPersistent, Painter, VtkPainter, java.lang.Comparable<Overlay>

Direct Known Subclasses:

ROI2D.ROI2DPainter, ROI3D.ROI3DPainter, ROI4DStack.ROI4DStackPainter, ROI5DStack.ROI5DStackPainter

Enclosing class:

ROI

public abstract class ROI.ROIPainter
extends Overlay
implements VtkPainter

Abstract basic class for ROI overlay

Nested Class Summary

Nested classes/interfaces inherited from class icy.painter.Overlay

Overlay.OverlayPriority

Field Summary

Fields inherited from class icy.painter.Overlay

ID_CANBEREMOVED, ID_CLASSNAME, ID_ID, ID_NAME, ID_OVERLAY, ID_PRIORITY, ID_READONLY, ID_RECEIVEKEYEVENTONHIDDEN, ID_RECEIVEMOUSEEVENTONHIDDEN, LOD_SMALL, LOD_TINY, PROPERTY_CANBEREMOVED, PROPERTY_NAME, PROPERTY_PERSISTENT, PROPERTY_PRIORITY, PROPERTY_READONLY, PROPERTY_RECEIVEKEYEVENTONHIDDEN, PROPERTY_RECEIVEMOUSEEVENTONHIDDEN

Constructor Summary

Constructors

Constructor and Description
ROI.ROIPainter()

Method Summary

Methods

Modifier and Type	Method and Description
void	computePriority()
double	getAdjustedStroke(IcyCanvas canvas) Get adjusted stroke for the current canvas transformation
java.awt.Color	getColor() Return the ROI painter base color.
java.awt.Color	getDisplayColor() Returns the color used to display the ROI depending its current state.
java.awt.Color	getFocusedColor() Returns the color for focused state
Point5D.Double	getMousePos() Deprecated. Better to retrieve mouse position from the IcyCanvas object.
java.lang.String	getName()
float	getOpacity() Returns the content opacity factor (0 = transparent while 1 means opaque).
vtk.vtkProp[]	getProps() Returns the VTK actors for this painter.
java.awt.Color	getSelectedColor() Deprecated.
boolean	getShowName() Return true if ROI painter should display the ROI name at draw time.
double	getStroke() Return the ROI painter stroke.
void	hideVtkObjects()
boolean	isReadOnly() Return read only property.
void	keyPressed(java.awt.event.KeyEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Key press event forwarded to the overlay.
void	keyReleased(java.awt.event.KeyEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Key release event forwarded to the overlay.
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
void	mouseClick(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Mouse click event forwarded to the overlay.
void	mouseDrag(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Mouse drag event forwarded to the overlay.
void	mouseMove(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Mouse move event forwarded to the overlay.
void	mousePressed(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Mouse press event forwarded to the overlay.
void	mouseReleased(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas) Mouse release event forwarded to the overlay.
void	paint(java.awt.Graphics2D g, Sequence sequence, IcyCanvas canvas) Paint method called to draw the overlay.
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setColor(java.awt.Color value) Set the ROI painter base color.
void	setMousePos(Point5D pos) Deprecated. Better to retrieve mouse position from the IcyCanvas object.
void	setName(java.lang.String name)
void	setOpacity(float value) Sets the content opacity factor (0 = transparent while 1 means opaque).
void	setSelectedColor(java.awt.Color value) Deprecated. Selected color is now automatically calculated
void	setShowName(boolean value) When set to true the ROI painter display the ROI name at draw time.
void	setStroke(double value) Set ROI painter stroke.

Methods inherited from class icy.painter.Overlay

addOverlayListener, attachTo, beginUpdate, changed, compareTo, createFromXML, detachFrom, endUpdate, getAttachedCanvas, getCanBeRemoved, getOptionsPanel, getOverlayCount, getPriority, getReceiveKeyEventOnHidden, getReceiveMouseEventOnHidden, getSequences, isAttached, isFixed, isPersistent, isUpdating, keyPressed, keyReleased, loadFromXML, loadOverlaysFromXML, mouseClick, mouseDrag, mouseEntered, mouseEntered, mouseExited, mouseExited, mouseMove, mousePressed, mouseReleased, mouseWheelMoved, mouseWheelMoved, onChanged, painterChanged, propertyChanged, remove, removeOverlayListener, saveOverlaysToXML, setCanBeRemoved, setFixed, setPersistent, setPriority, setReadOnly, setReceiveKeyEventOnHidden, setReceiveMouseEventOnHidden

Methods inherited from class java.lang.Object

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

Constructor Detail

ROI.ROIPainter

public ROI.ROIPainter()

Method Detail

getStroke

public double getStroke()

Return the ROI painter stroke.

getAdjustedStroke

public double getAdjustedStroke(IcyCanvas canvas)

Get adjusted stroke for the current canvas transformation

setStroke

public void setStroke(double value)

Set ROI painter stroke.

getOpacity

public float getOpacity()

Returns the content opacity factor (0 = transparent while 1 means opaque).

setOpacity

public void setOpacity(float value)

Sets the content opacity factor (0 = transparent while 1 means opaque).

getFocusedColor

public java.awt.Color getFocusedColor()

Returns the color for focused state

getSelectedColor

@Deprecated
public java.awt.Color getSelectedColor()

Deprecated.

getDisplayColor

public java.awt.Color getDisplayColor()

Returns the color used to display the ROI depending its current state.

getColor

public java.awt.Color getColor()

Return the ROI painter base color.

setColor

public void setColor(java.awt.Color value)

Set the ROI painter base color.

getShowName

public boolean getShowName()

Return true if ROI painter should display the ROI name at draw time.

setShowName

public void setShowName(boolean value)

When set to true the ROI painter display the ROI name at draw time.

setSelectedColor

@Deprecated
public void setSelectedColor(java.awt.Color value)

Deprecated. Selected color is now automatically calculated

getMousePos

@Deprecated
public Point5D.Double getMousePos()

Deprecated. Better to retrieve mouse position from the IcyCanvas object.

setMousePos

@Deprecated
public void setMousePos(Point5D pos)

Deprecated. Better to retrieve mouse position from the IcyCanvas object.

computePriority

public void computePriority()

isReadOnly

public boolean isReadOnly()

Description copied from class: Overlay

Return read only property.
When set to true we cannot anymore modify overlay properties from the GUI.

Overrides:

isReadOnly in class Overlay

getName

public java.lang.String getName()

Overrides:

getName in class Overlay

Returns:

the name

setName

public void setName(java.lang.String name)

Overrides:

setName in class Overlay

Parameters:

name - the name to set

keyPressed

public void keyPressed(java.awt.event.KeyEvent e,
              Point5D.Double imagePoint,
              IcyCanvas canvas)

Description copied from class: Overlay

Key press event forwarded to the overlay.

Overrides:

keyPressed in class Overlay

Parameters:

e - key event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

keyReleased

public void keyReleased(java.awt.event.KeyEvent e,
               Point5D.Double imagePoint,
               IcyCanvas canvas)

Description copied from class: Overlay

Key release event forwarded to the overlay.

Overrides:

keyReleased in class Overlay

Parameters:

e - key event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

mousePressed

public void mousePressed(java.awt.event.MouseEvent e,
                Point5D.Double imagePoint,
                IcyCanvas canvas)

Description copied from class: Overlay

Mouse press event forwarded to the overlay.

Overrides:

mousePressed in class Overlay

Parameters:

e - mouse event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e,
                 Point5D.Double imagePoint,
                 IcyCanvas canvas)

Description copied from class: Overlay

Mouse release event forwarded to the overlay.

Overrides:

mouseReleased in class Overlay

Parameters:

e - mouse event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

mouseClick

public void mouseClick(java.awt.event.MouseEvent e,
              Point5D.Double imagePoint,
              IcyCanvas canvas)

Description copied from class: Overlay

Mouse click event forwarded to the overlay.

Overrides:

mouseClick in class Overlay

Parameters:

e - mouse event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

mouseDrag

public void mouseDrag(java.awt.event.MouseEvent e,
             Point5D.Double imagePoint,
             IcyCanvas canvas)

Description copied from class: Overlay

Mouse drag event forwarded to the overlay.

Overrides:

mouseDrag in class Overlay

Parameters:

e - mouse event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

mouseMove

public void mouseMove(java.awt.event.MouseEvent e,
             Point5D.Double imagePoint,
             IcyCanvas canvas)

Description copied from class: Overlay

Mouse move event forwarded to the overlay.

Overrides:

mouseMove in class Overlay

Parameters:

e - mouse event

imagePoint - mouse position (image coordinates)

canvas - icy canvas

paint

public void paint(java.awt.Graphics2D g,
         Sequence sequence,
         IcyCanvas canvas)

Description copied from class: Overlay

Paint method called to draw the overlay.

Specified by:

paint in interface Painter

Overrides:

paint in class Overlay

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 Overlay

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 Overlay

getProps

public vtk.vtkProp[] getProps()

Description copied from interface: VtkPainter

Returns the VTK actors for this painter.

Specified by:

getProps in interface VtkPainter

hideVtkObjects

public void hideVtkObjects()