VolumeRenderer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- voltex.VolumeRenderer

All Implemented Interfaces:

AxisConstants

Direct Known Subclasses:

MultiOrthoslice, Orthoslice
```
public class VolumeRenderer
extends Object
implements AxisConstants
```
This class is the main class for creating a volume rendering. It consists of a root branch group, which holds a Switch of OrderedGroups. Each OrderedGroup holds the shapes for one direction. One shape consists of a rectangular geometry on which a texture from the given image data is mapped.

Author:

Benjamin Schmid

Field Summary

Fields
Modifier and Type	Field and Description
`protected AppearanceCreator`	`appCreator` The AppearanceCreator, which creates the textures.
`protected int[][]`	`axisIndex` The index in the switch, given the direction
`protected Switch`	`axisSwitch` A Switch, which holds 6 OrderedGroups, one for each direction
`protected GeometryCreator`	`geomCreator` The GeometryCreator, which creates the corresponding geomentries.
`protected BranchGroup`	`root` The root BranchGroup whose subtree contains the volume rendering
`protected VoltexVolume`	`volume` The image data which is rendered by this VolumeRenderer

Fields inherited from interface ij3d.AxisConstants
BACK, FRONT, X_AXIS, Y_AXIS, Z_AXIS

Constructor Summary

Constructors
Constructor and Description

VolumeRenderer(ij.ImagePlus img, Color3f color, float tr, boolean[] channels)
Constructor.

Constructors
Constructor and Description
`VolumeRenderer(ij.ImagePlus img, Color3f color, float tr, boolean[] channels)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mask`	`createMask()` Create a mask to this volume.
`void`	`disableTextures()`
`void`	`enableTextures()`
`void`	`eyePtChanged(View view)`
`void`	`fullReload()` Fully removes all the data and reloads all the textures.
`Appearance`	`getAppearance(int axis, int index)` Get the Appearance object for the Shape3D of the specified axis; Note that both front and back shapes share the same Appearance.
`VoltexVolume`	`getVolume()` Returns the image data of this rendering.
`BranchGroup`	`getVolumeNode()` Returns the root BranchGroup below which the whole volume rendering is organized.
`protected void`	`loadAxis(int axis)` Load a specific axis (both front and back direction) This method is protected, so that it can eventually be overridden by subclasses like Orthoslice.
`protected void`	`loadAxis(int axis, int index, Group front, Group back)` Load a specific slice of the specified axis (both front and back direction) and adds it to the specified Groups.
`void`	`setChannels(boolean[] channels)` Set the displayed color channels for this volume rendering.
`void`	`setColor(Color3f color)` Set the color for this volume rendering
`void`	`setLUTs(int[] r, int[] g, int[] b, int[] a)` Update the lookup tables for this volume rendering.
`void`	`setThreshold(int threshold)` Set the threshold.
`void`	`setTransparency(float transparency)` Set the transparency for this rendering

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

- Field Detail
  - volume
```
protected final VoltexVolume volume
```
    The image data which is rendered by this VolumeRenderer
  - root
```
protected final BranchGroup root
```
    The root BranchGroup whose subtree contains the volume rendering
  - appCreator
```
protected final AppearanceCreator appCreator
```
    The AppearanceCreator, which creates the textures.
  - geomCreator
```
protected final GeometryCreator geomCreator
```
    The GeometryCreator, which creates the corresponding geomentries.
  - axisSwitch
```
protected final Switch axisSwitch
```
    A Switch, which holds 6 OrderedGroups, one for each direction
  - axisIndex
```
protected final int[][] axisIndex
```
    The index in the switch, given the direction
- Constructor Detail
  - VolumeRenderer
```
public VolumeRenderer(ij.ImagePlus img,
                      Color3f color,
                      float tr,
                      boolean[] channels)
```
    Constructor. Initializes this VolumeRenderer with the given image, color, transparency and channels. This does not yet start the rendering. To do so, fullReload() needs to be called.
    
    Parameters:
    
    img - the image stack to be rendered.
    
    color - the color in which this rendering should be displayed
    
    tr - the transparency value for this volume rendering
    
    channels - the rgb channels which should be used. This must be a boolean[] array of length three, one for red, green and blue respectively.
- Method Detail
  - disableTextures
```
public void disableTextures()
```
  - enableTextures
```
public void enableTextures()
```
  - getVolumeNode
```
public BranchGroup getVolumeNode()
```
    Returns the root BranchGroup below which the whole volume rendering is organized.
    
    Returns:
  - getVolume
```
public VoltexVolume getVolume()
```
    Returns the image data of this rendering.
    
    Returns:
  - getAppearance
```
public Appearance getAppearance(int axis,
                                int index)
```
    Get the Appearance object for the Shape3D of the specified axis; Note that both front and back shapes share the same Appearance.
  - createMask
```
public Mask createMask()
```
    Create a mask to this volume.
  - eyePtChanged
```
public void eyePtChanged(View view)
```
  - fullReload
```
public void fullReload()
```
    Fully removes all the data and reloads all the textures.
  - setThreshold
```
public void setThreshold(int threshold)
```
    Set the threshold. Pixel value below the threshold are not rendered.
    
    Parameters:
    
    threshold -
  - setTransparency
```
public void setTransparency(float transparency)
```
    Set the transparency for this rendering
    
    Parameters:
    
    transparency -
  - setChannels
```
public void setChannels(boolean[] channels)
```
    Set the displayed color channels for this volume rendering. This affects only RGB images. A boolean[] array is required of length 3, one value for red, green and blue.
    
    Parameters:
    
    channels -
  - setLUTs
```
public void setLUTs(int[] r,
                    int[] g,
                    int[] b,
                    int[] a)
```
    Update the lookup tables for this volume rendering.
  - setColor
```
public void setColor(Color3f color)
```
    Set the color for this volume rendering
    
    Parameters:
    
    color -
  - loadAxis
```
protected void loadAxis(int axis)
```
    Load a specific axis (both front and back direction) This method is protected, so that it can eventually be overridden by subclasses like Orthoslice.
    
    Parameters:
    
    axis -
  - loadAxis
```
protected void loadAxis(int axis,
                        int index,
                        Group front,
                        Group back)
```
    Load a specific slice of the specified axis (both front and back direction) and adds it to the specified Groups. This method is protected, so that it can eventually be overridden by subclasses like Orthoslice.
    
    Parameters:
    
    axis -
    
    index -
    
    front -
    
    back -

Class VolumeRenderer

Field Summary

Fields inherited from interface ij3d.AxisConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

volume

root

appCreator

geomCreator

axisSwitch

axisIndex

Constructor Detail

VolumeRenderer

Method Detail

disableTextures

enableTextures

getVolumeNode

getVolume

getAppearance

createMask

eyePtChanged

fullReload

setThreshold

setTransparency

setChannels

setLUTs

setColor

loadAxis

loadAxis