VtkCanvas

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - icy.canvas.IcyCanvas
        
        icy.canvas.IcyCanvas3D
        
        icy.canvas.Canvas3D
        
        plugins.kernel.canvas.VtkCanvas

All Implemented Interfaces:

Layer.LayerListener, ChangeListener, ViewerListener, LUTListener, SequenceListener, java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, VtkSettingPanel.SettingChangeListener
```
public class VtkCanvas
extends Canvas3D
implements java.awt.event.ActionListener, VtkSettingPanel.SettingChangeListener
```
VTK 3D canvas class.

Author:

Stephane

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.BaselineResizeBehavior

Field Summary

Fields
Modifier and Type	Field and Description
`static java.awt.Image`	`ICON_AXES3D` icons
`static java.awt.Image`	`ICON_BOUNDINGBOX`
`static java.awt.Image`	`ICON_GRID`
`static java.awt.Image`	`ICON_RULER`
`static java.awt.Image`	`ICON_RULERLABEL`
`static java.awt.Image`	`ICON_TARGET`
`static java.lang.String`	`PROPERTY_AXES` properties
`static java.lang.String`	`PROPERTY_BOUNDINGBOX`
`static java.lang.String`	`PROPERTY_BOUNDINGBOX_GRID`
`static java.lang.String`	`PROPERTY_BOUNDINGBOX_LABELS`
`static java.lang.String`	`PROPERTY_BOUNDINGBOX_RULES`
`static java.lang.String`	`PROPERTY_BOUNDS`
`static java.lang.String`	`PROPERTY_DATA`
`static java.lang.String`	`PROPERTY_LUT`
`static java.lang.String`	`PROPERTY_SCALE`
`static vtk.vtkInformationIntegerKey`	`visibilityKey` Used for outline visibility information in vtkActor

Fields inherited from class icy.canvas.IcyCanvas
PROPERTY_LAYERS_VISIBLE

Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

VtkCanvas(Viewer viewer)

Constructors
Constructor and Description
`VtkCanvas(Viewer viewer)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent e)`
`Point3D.Double`	`canvasToImage(int x, int y)` Convert specified canvas point to image point
`void`	`changed(IcyCanvasEvent event)` canvas changed (packed event).
`void`	`customizeToolbar(javax.swing.JToolBar toolBar)` Called by the parent viewer when building the toolbar.
`Point3D`	`displayToWorld(double x, double y, double z)` Convert display coordinates to world coordinates.
`Point3D`	`displayToWorld(int x, int y)` Convert display coordinates to world coordinates.
`Point3D`	`displayToWorld(java.awt.Point pt)` Convert display coordinates to world coordinates.
`Point3D`	`displayToWorld(java.awt.Point pt, double z)` Convert display coordinates to world coordinates.
`vtk.vtkCamera`	`getActiveCam()` Deprecated. Use `getCamera()` instead
`vtk.vtkAxesActor`	`getAxes()`
`java.awt.Color`	`getBackgroundColor()` Returns rendering background color
`vtk.vtkCubeAxesActor`	`getBoundingBox()`
`vtk.vtkCamera`	`getCamera()`
`boolean`	`getGPURendering()`
`VtkImageVolume`	`getImageVolume()`
`vtk.vtkLight`	`getLight()`
`IcyVtkPanel`	`getPanel3D()` Deprecated. Use `getVtkPanel()`
`vtk.vtkProp`	`getPickedObject()` Returns the picked object on the last mouse move/drag event (can be `null` if no object was picked).
`vtk.vtkPicker`	`getPicker()`
`boolean`	`getPickOnMouseMove()` Deprecated. Always enabled now (always return `true`)
`java.awt.image.BufferedImage`	`getRenderedImage(int t, int c)` Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, c).
`java.awt.image.BufferedImage`	`getRenderedImage(int t, int z, int c, boolean canvasView)` Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
`vtk.vtkRenderer`	`getRenderer()`
`vtk.vtkRenderWindow`	`getRenderWindow()`
`vtk.vtkCubeAxesActor`	`getRulerBox()`
`double`	`getScaleX()` X scale factor
`double`	`getScaleY()` Y scale factor
`java.awt.Component`	`getViewComponent()`
`double`	`getVolumeAmbient()`
`VtkImageVolume.VtkVolumeBlendType`	`getVolumeBlendingMode()`
`double`	`getVolumeDiffuse()`
`int`	`getVolumeInterpolation()`
`VtkImageVolume.VtkVolumeMapperType`	`getVolumeMapperType()` Deprecated. Use `getGPURendering()` instead
`int`	`getVolumeSample()`
`double[]`	`getVolumeScale()` Get scaling for image volume rendering
`double`	`getVolumeSpecular()`
`IcyVtkPanel`	`getVtkPanel()`
`vtk.vtkOrientationMarkerWidget`	`getWidget()` Deprecated. there is no more orientation widget because of the jogl bug with multiple viewport.
`double`	`getWorldZ(int x, int y)` Return reached z world position (normalized) for specified display position
`double`	`getWorldZ(java.awt.Point pt)`
`java.awt.Point`	`imageToCanvas(double x, double y, double z)` Convert specified image point to canvas point.
`boolean`	`isAxisVisible()` Returns `true` if the 3D axis are visible.
`boolean`	`isBoundingBoxGridVisible()` Returns `true` if the volume bounding box grid is visible.
`boolean`	`isBoundingBoxRulerLabelsVisible()` Returns `true` if the volume bounding box ruler labels are visible.
`boolean`	`isBoundingBoxRulerVisible()` Returns `true` if the volume bounding box ruler are visible.
`boolean`	`isBoundingBoxVisible()` Returns `true` if the volume bounding box is visible.
`boolean`	`isInitialized()` Returns initialized state of VtkCanvas
`boolean`	`isVolumeShadingEnable()`
`boolean`	`isVolumeVisible()`
`void`	`keyPressed(java.awt.event.KeyEvent e)`
`void`	`keyReleased(java.awt.event.KeyEvent e)`
`void`	`lock()` Deprecated. Use `getVtkPanel().lock()` instead.
`vtk.vtkActor`	`pick(int x, int y)` Deprecated. use `pickProp(int, int)` instead.
`vtk.vtkProp`	`pickProp(int x, int y)` Pick object at specified position and return it.
`void`	`refresh()` Force render refresh
`void`	`setAxisVisible(boolean value)` Enable / disable 3D axis display.
`void`	`setBackgroundColor(java.awt.Color value)` Sets rendering background color
`void`	`setBackgroundColorInternal(java.awt.Color color)` Set background color (internal)
`void`	`setBoundingBoxColor(java.awt.Color color)` Deprecated. USe `setBackgroundColorInternal(Color)`
`void`	`setBoundingBoxGridVisible(boolean value)` Enable / disable volume bounding box grid display.
`void`	`setBoundingBoxRulerLabelsVisible(boolean value)` Enable / disable volume bounding box ruler labels display.
`void`	`setBoundingBoxRulerVisible(boolean value)` Enable / disable volume bounding box ruler display.
`void`	`setBoundingBoxVisible(boolean value)` Enable / disable volume bounding box display.
`void`	`setGPURendering(boolean value)`
`void`	`setMouseImagePosX(double value)` Set mouse X image position
`void`	`setMouseImagePosY(double value)` Set mouse Y image position
`void`	`setMouseImagePosZ(double value)` Set mouse Z image position
`void`	`setPickOnMouseMove(boolean value)` Deprecated. Always enable now
`void`	`settingChange(java.beans.PropertyChangeEvent evt)`
`void`	`setVolumeAmbient(double value)`
`void`	`setVolumeBlendingMode(VtkImageVolume.VtkVolumeBlendType value)`
`void`	`setVolumeDiffuse(double value)`
`void`	`setVolumeDistanceSample(int value)` Deprecated. Use `setVolumeSample(int)` instead
`void`	`setVolumeInterpolation(int value)`
`void`	`setVolumeMapperType(VtkImageVolume.VtkVolumeMapperType value)` Deprecated. Use `setGPURendering(boolean)` instead
`void`	`setVolumeSample(int value)`
`void`	`setVolumeScale(double x, double y, double z)` Set scaling for image volume rendering
`void`	`setVolumeShadingEnable(boolean value)`
`void`	`setVolumeSpecular(double value)`
`void`	`setVolumeVisible(boolean value)` Sets the visible state of the image volume object
`void`	`shutDown()` Called by the viewer when canvas is closed to release some resources.
`void`	`unlock()` Deprecated. Use `getVtkPanel().unlock()` instead.
`Point3D`	`worldToDisplay(double x, double y, double z)` Convert world coordinates to display coordinates
`Point3D`	`worldToDisplay(Point3D pt)` Convert world coordinates to display coordinates

Methods inherited from class icy.canvas.Canvas3D
getVolumeScaleX, getVolumeScaleY, getVolumeScaleZ, getXScaling, getYScaling, getZScaling, setVolumeScaleX, setVolumeScaleY, setVolumeScaleZ, setXScaling, setYScaling, setZScaling

Methods inherited from class icy.canvas.IcyCanvas3D
canvasToImage, centerOn, getMouseImagePos, getMouseImagePosX, getMouseImagePosY, getMouseImagePosZ, imageToCanvas, setMouseImagePos, setMouseImagePos, setMousePos, setPositionT

Methods inherited from class icy.canvas.IcyCanvas
addCanvasListener, addLayer, addLayer, addLayerListener, addLayersListener, addViewerToolbarComponents, addVisibleLayerToList, beginUpdate, canvasToImageC, canvasToImageDeltaC, canvasToImageDeltaT, canvasToImageDeltaX, canvasToImageDeltaY, canvasToImageDeltaZ, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaZ, canvasToImageLogDeltaZ, canvasToImageT, canvasToImageX, canvasToImageY, canvasToImageZ, create, endUpdate, getC, getCanvasClassName, getCanvasClassName, getCanvasOffsetC, getCanvasOffsetT, getCanvasOffsetX, getCanvasOffsetY, getCanvasOffsetZ, getCanvasPluginNames, getCanvasPlugins, getCanvasSize, getCanvasSizeC, getCanvasSizeT, getCanvasSizeX, getCanvasSizeY, getCanvasSizeZ, getCurrentImage, getDrawLayers, getFrameRate, getImage, getImage, getImageCanvasSize, getImageCanvasSizeC, getImageCanvasSizeT, getImageCanvasSizeX, getImageCanvasSizeY, getImageCanvasSizeZ, getImageLayer, getImageOffsetC, getImageOffsetT, getImageOffsetX, getImageOffsetY, getImageOffsetZ, getImageOverlay, getImageSize, getImageSizeC, getImageSizeT, getImageSizeX, getImageSizeY, getImageSizeZ, getLayer, getLayer, getLayer, getLayerListeners, getLayers, getLayers, getLayersPainter, getListeners, getLut, getMax, getMaxC, getMaxPosition, getMaxPosition5D, getMaxPositionC, getMaxPositionT, getMaxPositionX, getMaxPositionY, getMaxPositionZ, getMaxT, getMaxX, getMaxY, getMaxZ, getMouseImageInfosPanel, getMouseImagePos, getMouseImagePos5D, getMouseImagePosC, getMouseImagePosT, getMousePos, getNumSelectedSamples, getOffset, getOffset5D, getOffsetC, getOffsetT, getOffsetX, getOffsetY, getOffsetZ, getOrderedLayersForEvent, getOverlays, getPanel, getPluginClassName, getPosition, getPosition5D, getPositionC, getPositionT, getPositionX, getPositionY, getPositionZ, getRenderedImage, getRenderedImage, getRenderedSequence, getRenderedSequence, getRenderedSequence, getRenderedSequence, getRotation, getRotationC, getRotationT, getRotationX, getRotationY, getRotationZ, getScale, getScaleC, getScaleFactorC, getScaleFactorT, getScaleFactorX, getScaleFactorY, getScaleFactorZ, getScaleT, getScaleZ, getSequence, getSyncId, getT, getTNavigationPanel, getViewer, getVisibleLayers, getVisibleLayers, getVisibleOrderedLayersForEvent, getZ, getZNavigationPanel, hasLayer, hasLayer, hasLayer, imageToCanvasC, imageToCanvasDeltaC, imageToCanvasDeltaT, imageToCanvasDeltaX, imageToCanvasDeltaY, imageToCanvasDeltaZ, imageToCanvasT, imageToCanvasX, imageToCanvasY, imageToCanvasZ, isLayersVisible, isSynchHeader, isSynchMaster, isSynchOnCursor, isSynchOnSlice, isSynchOnView, isSynchronizationSupported, isSynchronized, isSynchSlave, isUpdating, isVisible, keyTyped, layerChanged, lutChanged, mouseClick, mouseClick, mouseDrag, mouseDrag, mouseEntered, mouseEntered, mouseExited, mouseExited, mouseImagePositionChanged, mouseMove, mouseMove, mousePressed, mousePressed, mouseReleased, mouseReleased, mouseWheelMoved, mouseWheelMoved, offsetChanged, onChanged, removeCanvasListener, removeLayer, removeLayer, removeLayer, removeLayerListener, removeLayersListener, rotationChanged, scaleChanged, sequenceChanged, sequenceClosed, setC, setDrawLayers, setFrameRate, setLayersVisible, setMouseImagePos, setMouseImagePosC, setMouseImagePosT, setMousePos, setOffset, setOffsetC, setOffsetT, setOffsetX, setOffsetY, setOffsetZ, setPosition, setPositionC, setPositionX, setPositionY, setPositionZ, setRotation, setRotationC, setRotationT, setRotationX, setRotationY, setRotationZ, setScale, setScaleC, setScaleT, setScaleX, setScaleY, setScaleZ, setSyncId, setT, setZ, viewerChanged, viewerClosed

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ICON_AXES3D
```
public static final java.awt.Image ICON_AXES3D
```
    icons
  - ICON_BOUNDINGBOX
```
public static final java.awt.Image ICON_BOUNDINGBOX
```
  - ICON_GRID
```
public static final java.awt.Image ICON_GRID
```
  - ICON_RULER
```
public static final java.awt.Image ICON_RULER
```
  - ICON_RULERLABEL
```
public static final java.awt.Image ICON_RULERLABEL
```
  - ICON_TARGET
```
public static final java.awt.Image ICON_TARGET
```
  - PROPERTY_AXES
```
public static final java.lang.String PROPERTY_AXES
```
    properties
    
    See Also:
    Constant Field Values
  - PROPERTY_BOUNDINGBOX
```
public static final java.lang.String PROPERTY_BOUNDINGBOX
```
    See Also:
    Constant Field Values
  - PROPERTY_BOUNDINGBOX_GRID
```
public static final java.lang.String PROPERTY_BOUNDINGBOX_GRID
```
    See Also:
    Constant Field Values
  - PROPERTY_BOUNDINGBOX_RULES
```
public static final java.lang.String PROPERTY_BOUNDINGBOX_RULES
```
    See Also:
    Constant Field Values
  - PROPERTY_BOUNDINGBOX_LABELS
```
public static final java.lang.String PROPERTY_BOUNDINGBOX_LABELS
```
    See Also:
    Constant Field Values
  - PROPERTY_LUT
```
public static final java.lang.String PROPERTY_LUT
```
    See Also:
    Constant Field Values
  - PROPERTY_DATA
```
public static final java.lang.String PROPERTY_DATA
```
    See Also:
    Constant Field Values
  - PROPERTY_SCALE
```
public static final java.lang.String PROPERTY_SCALE
```
    See Also:
    Constant Field Values
  - PROPERTY_BOUNDS
```
public static final java.lang.String PROPERTY_BOUNDS
```
    See Also:
    Constant Field Values
  - visibilityKey
```
public static final vtk.vtkInformationIntegerKey visibilityKey
```
    Used for outline visibility information in vtkActor
- Constructor Detail
  - VtkCanvas
```
public VtkCanvas(Viewer viewer)
```
- Method Detail
  - shutDown
```
public void shutDown()
```
    Description copied from class: IcyCanvas
    
    Called by the viewer when canvas is closed to release some resources.
    Be careful to not restore previous state here (as the colormap) because generally shutdown is called after the creation of the other canvas.
    
    Overrides:
    
    shutDown in class IcyCanvas
  - isInitialized
```
public boolean isInitialized()
```
    Returns initialized state of VtkCanvas
  - customizeToolbar
```
public void customizeToolbar(javax.swing.JToolBar toolBar)
```
    Description copied from class: IcyCanvas
    
    Called by the parent viewer when building the toolbar.
    This way the canvas can customize it by adding specific command for instance.
    
    Overrides:
    
    customizeToolbar in class IcyCanvas
    
    Parameters:
    toolBar - the parent toolbar to customize
  - lock
```
@Deprecated
public void lock()
```
    Deprecated. Use getVtkPanel().lock() instead.
    
    Request exclusive access to VTK rendering.
  - unlock
```
@Deprecated
public void unlock()
```
    Deprecated. Use getVtkPanel().unlock() instead.
    
    Release exclusive access from VTK rendering.
  - getActiveCam
```
@Deprecated
public vtk.vtkCamera getActiveCam()
```
    Deprecated. Use getCamera() instead
  - getCamera
```
public vtk.vtkCamera getCamera()
```
    Returns:
    the VTK scene camera object
  - getLight
```
public vtk.vtkLight getLight()
```
    Returns:
    the VTK default scene light object.
    Can be null if render window is not yet initialized.
  - getAxes
```
public vtk.vtkAxesActor getAxes()
```
    Returns:
    the VTK axes object
  - getBoundingBox
```
public vtk.vtkCubeAxesActor getBoundingBox()
```
    Returns:
    the VTK bounding box object
  - getRulerBox
```
public vtk.vtkCubeAxesActor getRulerBox()
```
    Returns:
    the VTK ruler box object
  - getWidget
```
@Deprecated
public vtk.vtkOrientationMarkerWidget getWidget()
```
    Deprecated. there is no more orientation widget because of the jogl bug with multiple viewport.
  - getImageVolume
```
public VtkImageVolume getImageVolume()
```
    Returns:
    the VTK image volume object
  - getBackgroundColor
```
public java.awt.Color getBackgroundColor()
```
    Returns rendering background color
  - setBackgroundColor
```
public void setBackgroundColor(java.awt.Color value)
```
    Sets rendering background color
  - isBoundingBoxVisible
```
public boolean isBoundingBoxVisible()
```
    Returns true if the volume bounding box is visible.
  - setBoundingBoxVisible
```
public void setBoundingBoxVisible(boolean value)
```
    Enable / disable volume bounding box display.
  - isBoundingBoxGridVisible
```
public boolean isBoundingBoxGridVisible()
```
    Returns true if the volume bounding box grid is visible.
  - setBoundingBoxGridVisible
```
public void setBoundingBoxGridVisible(boolean value)
```
    Enable / disable volume bounding box grid display.
  - isBoundingBoxRulerVisible
```
public boolean isBoundingBoxRulerVisible()
```
    Returns true if the volume bounding box ruler are visible.
  - setBoundingBoxRulerVisible
```
public void setBoundingBoxRulerVisible(boolean value)
```
    Enable / disable volume bounding box ruler display.
  - isBoundingBoxRulerLabelsVisible
```
public boolean isBoundingBoxRulerLabelsVisible()
```
    Returns true if the volume bounding box ruler labels are visible.
  - setBoundingBoxRulerLabelsVisible
```
public void setBoundingBoxRulerLabelsVisible(boolean value)
```
    Enable / disable volume bounding box ruler labels display.
  - setBoundingBoxColor
```
@Deprecated
public void setBoundingBoxColor(java.awt.Color color)
```
    Deprecated. USe setBackgroundColorInternal(Color)
  - setBackgroundColorInternal
```
public void setBackgroundColorInternal(java.awt.Color color)
```
    Set background color (internal)
  - isAxisVisible
```
public boolean isAxisVisible()
```
    Returns true if the 3D axis are visible.
  - setAxisVisible
```
public void setAxisVisible(boolean value)
```
    Enable / disable 3D axis display.
  - getVolumeBlendingMode
```
public VtkImageVolume.VtkVolumeBlendType getVolumeBlendingMode()
```
    See Also:
    VtkImageVolume.getBlendingMode()
  - setVolumeBlendingMode
```
public void setVolumeBlendingMode(VtkImageVolume.VtkVolumeBlendType value)
```
    See Also:
    VtkImageVolume.setBlendingMode(VtkVolumeBlendType)
  - getVolumeSample
```
public int getVolumeSample()
```
    See Also:
    VtkImageVolume.getSampleResolution()
  - setVolumeSample
```
public void setVolumeSample(int value)
```
    See Also:
    VtkImageVolume.setSampleResolution(double)
  - isVolumeShadingEnable
```
public boolean isVolumeShadingEnable()
```
    See Also:
    VtkImageVolume.getShade()
  - setVolumeShadingEnable
```
public void setVolumeShadingEnable(boolean value)
```
    See Also:
    VtkImageVolume.setShade(boolean)
  - getVolumeAmbient
```
public double getVolumeAmbient()
```
    See Also:
    VtkImageVolume.getAmbient()
  - setVolumeAmbient
```
public void setVolumeAmbient(double value)
```
    See Also:
    VtkImageVolume.setAmbient(double)
  - getVolumeDiffuse
```
public double getVolumeDiffuse()
```
    See Also:
    VtkImageVolume.getDiffuse()
  - setVolumeDiffuse
```
public void setVolumeDiffuse(double value)
```
    See Also:
    VtkImageVolume.setDiffuse(double)
  - getVolumeSpecular
```
public double getVolumeSpecular()
```
    See Also:
    VtkImageVolume.getSpecular()
  - setVolumeSpecular
```
public void setVolumeSpecular(double value)
```
    See Also:
    VtkImageVolume.setSpecular(double)
  - getVolumeInterpolation
```
public int getVolumeInterpolation()
```
    See Also:
    VtkImageVolume.getInterpolationMode()
  - setVolumeInterpolation
```
public void setVolumeInterpolation(int value)
```
    See Also:
    VtkImageVolume.setInterpolationMode(int)
  - getGPURendering
```
public boolean getGPURendering()
```
    See Also:
    VtkImageVolume.getGPURendering()
  - setGPURendering
```
public void setGPURendering(boolean value)
```
    See Also:
    VtkImageVolume.setGPURendering(boolean)
  - getVolumeMapperType
```
@Deprecated
public VtkImageVolume.VtkVolumeMapperType getVolumeMapperType()
```
    Deprecated. Use getGPURendering() instead
  - setVolumeMapperType
```
@Deprecated
public void setVolumeMapperType(VtkImageVolume.VtkVolumeMapperType value)
```
    Deprecated. Use setGPURendering(boolean) instead
  - isVolumeVisible
```
public boolean isVolumeVisible()
```
    Returns:
    visible state of the image volume object
    See Also:
    VtkImageVolume.isVisible()
  - setVolumeVisible
```
public void setVolumeVisible(boolean value)
```
    Sets the visible state of the image volume object
    
    See Also:
    VtkImageVolume.setVisible(boolean)
  - refresh
```
public void refresh()
```
    Force render refresh
    
    Specified by:
    
    refresh in class IcyCanvas
  - setVolumeDistanceSample
```
@Deprecated
public void setVolumeDistanceSample(int value)
```
    Deprecated. Use setVolumeSample(int) instead
    
    Description copied from class: Canvas3D
    Adjust the volume image resolution rendering.
    - 0 = auto selection
    - 1 = highest resolution (slow)
    - 10 = lowest resolution (fast)
    Specified by:
    
    setVolumeDistanceSample in class Canvas3D
  - getPickOnMouseMove
```
@Deprecated
public boolean getPickOnMouseMove()
```
    Deprecated. Always enabled now (always return true)
  - setPickOnMouseMove
```
@Deprecated
public void setPickOnMouseMove(boolean value)
```
    Deprecated. Always enable now
  - getPickedObject
```
public vtk.vtkProp getPickedObject()
```
    Returns the picked object on the last mouse move/drag event (can be null if no object was picked).
    
    See Also:
    pickProp(int, int)
  - pick
```
@Deprecated
public vtk.vtkActor pick(int x,
                           int y)
```
    Deprecated. use pickProp(int, int) instead.
  - pickProp
```
public vtk.vtkProp pickProp(int x,
                   int y)
```
    Pick object at specified position and return it.
    
    See Also:
    getPickedObject(), IcyVtkPanel.pick(int, int)
  - getWorldZ
```
public double getWorldZ(int x,
               int y)
```
    Return reached z world position (normalized) for specified display position
  - getWorldZ
```
public double getWorldZ(java.awt.Point pt)
```
  - worldToDisplay
```
public Point3D worldToDisplay(Point3D pt)
```
    Convert world coordinates to display coordinates
  - worldToDisplay
```
public Point3D worldToDisplay(double x,
                     double y,
                     double z)
```
    Convert world coordinates to display coordinates
  - displayToWorld
```
public Point3D displayToWorld(java.awt.Point pt)
```
    Convert display coordinates to world coordinates.
  - displayToWorld
```
public Point3D displayToWorld(int x,
                     int y)
```
    Convert display coordinates to world coordinates.
  - displayToWorld
```
public Point3D displayToWorld(java.awt.Point pt,
                     double z)
```
    Convert display coordinates to world coordinates.
    Default value for Z should be 0d
  - displayToWorld
```
public Point3D displayToWorld(double x,
                     double y,
                     double z)
```
    Convert display coordinates to world coordinates.
    Default value for Z is 0d
  - imageToCanvas
```
public java.awt.Point imageToCanvas(double x,
                           double y,
                           double z)
```
    Description copied from class: IcyCanvas3D
    
    Convert specified image point to canvas point.
    
    Overrides:
    
    imageToCanvas in class IcyCanvas3D
  - canvasToImage
```
public Point3D.Double canvasToImage(int x,
                           int y)
```
    Description copied from class: IcyCanvas3D
    
    Convert specified canvas point to image point
    
    Overrides:
    
    canvasToImage in class IcyCanvas3D
  - getViewComponent
```
public java.awt.Component getViewComponent()
```
    Specified by:
    
    getViewComponent in class IcyCanvas
    
    Returns:
    the main view component
  - getVtkPanel
```
public IcyVtkPanel getVtkPanel()
```
  - getPanel3D
```
@Deprecated
public IcyVtkPanel getPanel3D()
```
    Deprecated. Use getVtkPanel()
    
    Specified by:
    
    getPanel3D in class Canvas3D
  - getRenderer
```
public vtk.vtkRenderer getRenderer()
```
    Specified by:
    
    getRenderer in class Canvas3D
  - getRenderWindow
```
public vtk.vtkRenderWindow getRenderWindow()
```
  - getPicker
```
public vtk.vtkPicker getPicker()
```
    See Also:
    IcyVtkPanel.getPicker()
  - getVolumeScale
```
public double[] getVolumeScale()
```
    Get scaling for image volume rendering
    
    Specified by:
    
    getVolumeScale in class Canvas3D
  - setVolumeScale
```
public void setVolumeScale(double x,
                  double y,
                  double z)
```
    Set scaling for image volume rendering
    
    Specified by:
    
    setVolumeScale in class Canvas3D
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyPressed in interface java.awt.event.KeyListener
    
    Overrides:
    
    keyPressed in class IcyCanvas
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyReleased in interface java.awt.event.KeyListener
    
    Overrides:
    
    keyReleased in class IcyCanvas
  - getScaleX
```
public double getScaleX()
```
    Description copied from class: IcyCanvas
    
    X scale factor
    
    Overrides:
    
    getScaleX in class IcyCanvas
  - getScaleY
```
public double getScaleY()
```
    Description copied from class: IcyCanvas
    
    Y scale factor
    
    Overrides:
    
    getScaleY in class IcyCanvas
  - setMouseImagePosX
```
public void setMouseImagePosX(double value)
```
    Description copied from class: IcyCanvas
    
    Set mouse X image position
    
    Overrides:
    
    setMouseImagePosX in class IcyCanvas
  - setMouseImagePosY
```
public void setMouseImagePosY(double value)
```
    Description copied from class: IcyCanvas
    
    Set mouse Y image position
    
    Overrides:
    
    setMouseImagePosY in class IcyCanvas
  - setMouseImagePosZ
```
public void setMouseImagePosZ(double value)
```
    Description copied from class: IcyCanvas
    
    Set mouse Z image position
    
    Overrides:
    
    setMouseImagePosZ in class IcyCanvas
  - getRenderedImage
```
public java.awt.image.BufferedImage getRenderedImage(int t,
                                            int c)
```
    Description copied from class: Canvas3D
    
    Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, c).
    
    Specified by:
    
    getRenderedImage in class Canvas3D
    
    Parameters:
    t - T position of wanted image (-1 for complete sequence)
    c - C position of wanted image (-1 for all channels)
  - getRenderedImage
```
public java.awt.image.BufferedImage getRenderedImage(int t,
                                            int z,
                                            int c,
                                            boolean canvasView)
```
    Description copied from class: IcyCanvas
    
    Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
    Free feel to the canvas to handle or not a specific dimension.
    
    Specified by:
    
    getRenderedImage in class IcyCanvas
    
    Parameters:
    t - T position of wanted image (-1 for complete sequence)
    z - Z position of wanted image (-1 for complete stack)
    c - C position of wanted image (-1 for all channels)
    canvasView - render with canvas view if true else use default sequence dimension
  - changed
```
public void changed(IcyCanvasEvent event)
```
    Description copied from class: IcyCanvas
    
    canvas changed (packed event).
    do global changes processing here
    
    Overrides:
    
    changed in class IcyCanvas
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
  - settingChange
```
public void settingChange(java.beans.PropertyChangeEvent evt)
```
    Specified by:
    
    settingChange in interface VtkSettingPanel.SettingChangeListener

Class VtkCanvas

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class icy.canvas.IcyCanvas

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class icy.canvas.Canvas3D

Methods inherited from class icy.canvas.IcyCanvas3D

Methods inherited from class icy.canvas.IcyCanvas

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

ICON_AXES3D

ICON_BOUNDINGBOX

ICON_GRID

ICON_RULER

ICON_RULERLABEL

ICON_TARGET

PROPERTY_AXES

PROPERTY_BOUNDINGBOX

PROPERTY_BOUNDINGBOX_GRID

PROPERTY_BOUNDINGBOX_RULES

PROPERTY_BOUNDINGBOX_LABELS

PROPERTY_LUT

PROPERTY_DATA

PROPERTY_SCALE

PROPERTY_BOUNDS

visibilityKey

Constructor Detail

VtkCanvas

Method Detail

shutDown

isInitialized

customizeToolbar

lock

unlock

getActiveCam

getCamera

getLight

getAxes

getBoundingBox

getRulerBox

getWidget

getImageVolume

getBackgroundColor

setBackgroundColor

isBoundingBoxVisible

setBoundingBoxVisible

isBoundingBoxGridVisible

setBoundingBoxGridVisible

isBoundingBoxRulerVisible

setBoundingBoxRulerVisible

isBoundingBoxRulerLabelsVisible

setBoundingBoxRulerLabelsVisible

setBoundingBoxColor

setBackgroundColorInternal

isAxisVisible

setAxisVisible

getVolumeBlendingMode

setVolumeBlendingMode

getVolumeSample

setVolumeSample

isVolumeShadingEnable

setVolumeShadingEnable

getVolumeAmbient

setVolumeAmbient

getVolumeDiffuse

setVolumeDiffuse

getVolumeSpecular

setVolumeSpecular

getVolumeInterpolation

setVolumeInterpolation