icy.painter

Class Anchor3D

java.lang.Object

icy.painter.Overlay

icy.painter.Anchor3D

All Implemented Interfaces:

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

public class Anchor3D
extends Overlay
implements VtkPainter, java.lang.Runnable

Anchor3D class, used for 3D point control.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Anchor3D.Anchor3DEvent
static interface	Anchor3D.Anchor3DPositionListener Interface to listen Anchor3D position change

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

Overlay.OverlayPriority

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	DEFAULT_NORMAL_COLOR
static int	DEFAULT_RAY
static java.awt.Color	DEFAULT_SELECTED_COLOR

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
Anchor3D()
Anchor3D(double x, double y, double z)
Anchor3D(double x, double y, double z, java.awt.Color color, java.awt.Color selectedColor)
Anchor3D(double x, double y, double z, int ray)
Anchor3D(double x, double y, double z, int ray, java.awt.Color color, java.awt.Color selectedColor)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPositionListener(Anchor3D.Anchor3DPositionListener listener)
java.awt.Color	getColor()
Point3D	getPosition() Get anchor position
Point3D	getPositionInternal() Get anchor position (return the internal reference)
vtk.vtkProp[]	getProps() Returns the VTK actors for this painter.
int	getRay()
java.awt.Color	getSelectedColor()
double	getX()
double	getY()
double	getZ()
boolean	isOver(IcyCanvas canvas, Point3D imagePoint) Returns true if specified Point3D is over the anchor in the specified canvas
boolean	isSelected()
boolean	isVisible()
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
boolean	loadPositionFromXML(org.w3c.dom.Node node)
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	onChanged(CollapsibleEvent object) fire changed event
void	paint(java.awt.Graphics2D g, Sequence sequence, IcyCanvas canvas) Paint method called to draw the overlay.
void	paint(java.awt.Graphics2D g, Sequence sequence, IcyCanvas canvas, boolean simplified)
void	removePositionListener(Anchor3D.Anchor3DPositionListener listener)
void	run()
boolean	savePositionToXML(org.w3c.dom.Node node)
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setColor(java.awt.Color value) Sets the color
void	setPosition(double x, double y, double z) Sets anchor position
void	setPosition(Point3D p) Sets anchor position
void	setRay(int value) Sets the ray
void	setSelected(boolean value) Sets the selected state
void	setSelectedColor(java.awt.Color value) Sets the selected state color
void	setVisible(boolean value)
void	setX(double value) Sets the X coordinate position
void	setY(double value) Sets the Y coordinate position
void	setZ(double value) Sets the Z coordinate position
void	translate(double dx, double dy, double dz) Performs a translation on the anchor position

Methods inherited from class icy.painter.Overlay

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RAY

public static final int DEFAULT_RAY

See Also:

Constant Field Values

DEFAULT_NORMAL_COLOR

public static final java.awt.Color DEFAULT_NORMAL_COLOR

DEFAULT_SELECTED_COLOR

public static final java.awt.Color DEFAULT_SELECTED_COLOR

Constructor Detail

Anchor3D

public Anchor3D(double x,
        double y,
        double z,
        int ray,
        java.awt.Color color,
        java.awt.Color selectedColor)

Anchor3D

public Anchor3D(double x,
        double y,
        double z,
        java.awt.Color color,
        java.awt.Color selectedColor)

Anchor3D

public Anchor3D(double x,
        double y,
        double z,
        int ray)

Anchor3D

public Anchor3D(double x,
        double y,
        double z)

Anchor3D

public Anchor3D()

Method Detail

getX

public double getX()

Returns:

X coordinate position

setX

public void setX(double value)

Sets the X coordinate position

getY

public double getY()

Returns:

Y coordinate position

setY

public void setY(double value)

Sets the Y coordinate position

getZ

public double getZ()

Returns:

Z coordinate position

setZ

public void setZ(double value)

Sets the Z coordinate position

getPositionInternal

public Point3D getPositionInternal()

Get anchor position (return the internal reference)

getPosition

public Point3D getPosition()

Get anchor position

setPosition

public void setPosition(Point3D p)

Sets anchor position

setPosition

public void setPosition(double x,
               double y,
               double z)

Sets anchor position

translate

public void translate(double dx,
             double dy,
             double dz)

Performs a translation on the anchor position

getRay

public int getRay()

Returns:

the ray

setRay

public void setRay(int value)

Sets the ray

getColor

public java.awt.Color getColor()

Returns:

the color

setColor

public void setColor(java.awt.Color value)

Sets the color

getSelectedColor

public java.awt.Color getSelectedColor()

Returns:

the selected state color

setSelectedColor

public void setSelectedColor(java.awt.Color value)

Sets the selected state color

isSelected

public boolean isSelected()

Returns:

the selected state

setSelected

public void setSelected(boolean value)

Sets the selected state

isVisible

public boolean isVisible()

Returns:

the visible

setVisible

public void setVisible(boolean value)

Parameters:

value - the visible to set

isOver

public boolean isOver(IcyCanvas canvas,
             Point3D imagePoint)

Returns true if specified Point3D is over the anchor in the specified canvas

onChanged

public void onChanged(CollapsibleEvent object)

Description copied from interface: ChangeListener

fire changed event

Specified by:

onChanged in interface ChangeListener

Overrides:

onChanged in class Overlay

addPositionListener

public void addPositionListener(Anchor3D.Anchor3DPositionListener listener)

removePositionListener

public void removePositionListener(Anchor3D.Anchor3DPositionListener listener)

getProps

public vtk.vtkProp[] getProps()

Description copied from interface: VtkPainter

Returns the VTK actors for this painter.

Specified by:

getProps in interface VtkPainter

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

paint

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

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

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

run

public void run()

Specified by:

run in interface java.lang.Runnable

loadPositionFromXML

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

savePositionToXML

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

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