VoltexGroup (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.SceneGraphObject
- - org.scijava.java3d.Node
  - - org.scijava.java3d.Group
    - - org.scijava.java3d.BranchGroup
      - ij3d.ContentNode
        
        voltex.VoltexGroup

Direct Known Subclasses:

MultiOrthoGroup, OrthoGroup
```
public class VoltexGroup
extends ContentNode
```
This class extends ContentNode to display a Content as a Volume Rendering.

Author:

Benjamin Schmid

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContentInstant`	`c` Reference to the Content which holds this VoltexGroup
`protected VolumeRenderer`	`renderer` The VolumeRenderer behind this VoltexGroup

Fields inherited from class org.scijava.java3d.BranchGroup
ALLOW_DETACH

Fields inherited from class org.scijava.java3d.Group
ALLOW_CHILDREN_EXTEND, ALLOW_CHILDREN_READ, ALLOW_CHILDREN_WRITE, ALLOW_COLLISION_BOUNDS_READ, ALLOW_COLLISION_BOUNDS_WRITE

Fields inherited from class org.scijava.java3d.Node
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VoltexGroup()` This constructor only exists to allow subclasses to access the super constructor of BranchGroup.
	`VoltexGroup(Content c)` Initialize this VoltexGroup with the specified Content.
	`VoltexGroup(ContentInstant c)` Initialize this VoltexGroup with the specified ContentInstant.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`calculateMinMaxCenterPoint()` Calculate the minimum, maximum and center coordinate, together with the volume.
`void`	`channelsUpdated(boolean[] channels)` This method is called when the channels of the Content have changed.
`void`	`clearDisplayedData()`
`void`	`colorUpdated(Color3f color)` This method is called when the color of the Content has changed.
`Mask`	`createMask()`
`void`	`eyePtChanged(View view)` This method is called when the view direction has changed.
`void`	`fillRoi(Canvas3D canvas, Roi roi, byte fillValue)` Fills the projection of the specified ROI with the given fillValue.
`void`	`getCenter(Tuple3d center)` Stores the center coordinate of this ContentNode in the specified Tuple3d
`void`	`getMax(Tuple3d max)` Stores the maximum coordinate of this ContentNode in the specified Tuple3d
`void`	`getMin(Tuple3d min)` Stores the minimum coordinate of this ContentNode in the specified Tuple3d
`VolumeRenderer`	`getRenderer()` Get a reference VolumeRenderer which is used by this class
`float`	`getVolume()` Returns the volume of this ContentNode.
`void`	`lutUpdated(int[] r, int[] g, int[] b, int[] a)` This method is called when the color lookup tables of the Content have changed.
`void`	`restoreDisplayedData(String path, String name)`
`void`	`shadeUpdated(boolean shaded)` This method is called when the 'shade' attribute of the Content has changed.
`void`	`swapDisplayedData(String path, String name)`
`void`	`thresholdUpdated(int threshold)` This method is called when the threshold of the Content has changed.
`void`	`transparencyUpdated(float transparency)` This method is called when the transparency of the Content has changed.
`void`	`update()` Update the volume rendering from the image (only if the resampling factor is 1.
`void`	`volumeToImagePlate(Transform3D toImagePlate)` Stores the matrix which transforms this VoltexGroup to the image plate in the specified Transform3D.

Methods inherited from class org.scijava.java3d.BranchGroup
cloneNode, compile, detach, pickAll, pickAll, pickAllSorted, pickAllSorted, pickAny, pickAny, pickClosest, pickClosest

Methods inherited from class org.scijava.java3d.Group
addChild, getAllChildren, getAlternateCollisionTarget, getChild, getCollisionBounds, indexOfChild, insertChild, moveTo, numChildren, removeAllChildren, removeChild, removeChild, setAlternateCollisionTarget, setChild, setCollisionBounds

Methods inherited from class org.scijava.java3d.Node
cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class org.scijava.java3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString, updateNodeReferences

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

- Field Detail
  - renderer
```
protected VolumeRenderer renderer
```
    The VolumeRenderer behind this VoltexGroup
  - c
```
protected ContentInstant c
```
    Reference to the Content which holds this VoltexGroup
- Constructor Detail
  - VoltexGroup
```
protected VoltexGroup()
```
    This constructor only exists to allow subclasses to access the super constructor of BranchGroup.
  - VoltexGroup
```
public VoltexGroup(Content c)
```
    Initialize this VoltexGroup with the specified Content.
    
    Parameters:
    
    c -
    
    Throws:
    
    IllegalArgumentException - if the specified Content has no image.
  - VoltexGroup
```
public VoltexGroup(ContentInstant c)
```
    Initialize this VoltexGroup with the specified ContentInstant.
    
    Parameters:
    
    c -
    
    Throws:
    
    IllegalArgumentException - if the specified ContentInstant has no image.
- Method Detail
  - update
```
public void update()
```
    Update the volume rendering from the image (only if the resampling factor is 1.
  - getRenderer
```
public VolumeRenderer getRenderer()
```
    Get a reference VolumeRenderer which is used by this class
  - createMask
```
public Mask createMask()
```
  - getMin
```
public void getMin(Tuple3d min)
```
    Description copied from class: ContentNode
    
    Stores the minimum coordinate of this ContentNode in the specified Tuple3d
    
    Specified by:
    
    getMin in class ContentNode
    
    See Also:
    
    getMin
  - getMax
```
public void getMax(Tuple3d max)
```
    Description copied from class: ContentNode
    
    Stores the maximum coordinate of this ContentNode in the specified Tuple3d
    
    Specified by:
    
    getMax in class ContentNode
    
    See Also:
    
    (Tuple3d) getMax
  - getCenter
```
public void getCenter(Tuple3d center)
```
    Description copied from class: ContentNode
    
    Stores the center coordinate of this ContentNode in the specified Tuple3d
    
    Specified by:
    
    getCenter in class ContentNode
    
    See Also:
    
    getCenter
  - thresholdUpdated
```
public void thresholdUpdated(int threshold)
```
    Description copied from class: ContentNode
    
    This method is called when the threshold of the Content has changed.
    
    Specified by:
    
    thresholdUpdated in class ContentNode
    
    See Also:
    
    thresholdUpdated
  - getVolume
```
public float getVolume()
```
    Description copied from class: ContentNode
    
    Returns the volume of this ContentNode.
    
    Specified by:
    
    getVolume in class ContentNode
    
    Returns:
    
    See Also:
    
    getVolume
  - eyePtChanged
```
public void eyePtChanged(View view)
```
    Description copied from class: ContentNode
    
    This method is called when the view direction has changed.
    
    Specified by:
    
    eyePtChanged in class ContentNode
    
    See Also:
    
    eyePtChanged
  - channelsUpdated
```
public void channelsUpdated(boolean[] channels)
```
    Description copied from class: ContentNode
    
    This method is called when the channels of the Content have changed.
    
    Specified by:
    
    channelsUpdated in class ContentNode
    
    See Also:
    
    channelsUpdated
  - lutUpdated
```
public void lutUpdated(int[] r,
                       int[] g,
                       int[] b,
                       int[] a)
```
    Description copied from class: ContentNode
    
    This method is called when the color lookup tables of the Content have changed.
    
    Specified by:
    
    lutUpdated in class ContentNode
    
    See Also:
    
    lutUpdated
  - shadeUpdated
```
public void shadeUpdated(boolean shaded)
```
    Description copied from class: ContentNode
    
    This method is called when the 'shade' attribute of the Content has changed.
    
    Specified by:
    
    shadeUpdated in class ContentNode
    
    See Also:
    
    shadeUpdated
  - colorUpdated
```
public void colorUpdated(Color3f color)
```
    Description copied from class: ContentNode
    
    This method is called when the color of the Content has changed.
    
    Specified by:
    
    colorUpdated in class ContentNode
    
    See Also:
    
    colorUpdated
  - transparencyUpdated
```
public void transparencyUpdated(float transparency)
```
    Description copied from class: ContentNode
    
    This method is called when the transparency of the Content has changed.
    
    Specified by:
    
    transparencyUpdated in class ContentNode
    
    See Also:
    
    transparencyUpdated
  - volumeToImagePlate
```
public void volumeToImagePlate(Transform3D toImagePlate)
```
    Stores the matrix which transforms this VoltexGroup to the image plate in the specified Transform3D.
    
    Parameters:
    
    toImagePlate -
  - fillRoi
```
public void fillRoi(Canvas3D canvas,
                    Roi roi,
                    byte fillValue)
```
    Fills the projection of the specified ROI with the given fillValue. Does nothing if the given ROI is null. Works not only on the internally created image (the resampled one), but also on the original image.
    
    Parameters:
    
    canvas -
    
    roi -
    
    fillValue -
  - calculateMinMaxCenterPoint
```
protected void calculateMinMaxCenterPoint()
```
    Calculate the minimum, maximum and center coordinate, together with the volume.
  - swapDisplayedData
```
public void swapDisplayedData(String path,
                              String name)
```
    Specified by:
    
    swapDisplayedData in class ContentNode
  - clearDisplayedData
```
public void clearDisplayedData()
```
    Specified by:
    
    clearDisplayedData in class ContentNode
  - restoreDisplayedData
```
public void restoreDisplayedData(String path,
                                 String name)
```
    Specified by:
    
    restoreDisplayedData in class ContentNode

Class VoltexGroup

Field Summary

Fields inherited from class org.scijava.java3d.BranchGroup

Fields inherited from class org.scijava.java3d.Group

Fields inherited from class org.scijava.java3d.Node

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.BranchGroup

Methods inherited from class org.scijava.java3d.Group

Methods inherited from class org.scijava.java3d.Node

Methods inherited from class org.scijava.java3d.SceneGraphObject

Methods inherited from class java.lang.Object

Field Detail

renderer

c

Constructor Detail

VoltexGroup

VoltexGroup

VoltexGroup

Method Detail

update

getRenderer

createMask

getMin

getMax

getCenter

thresholdUpdated

getVolume

eyePtChanged

channelsUpdated

lutUpdated

shadeUpdated

colorUpdated

transparencyUpdated

volumeToImagePlate

fillRoi

calculateMinMaxCenterPoint

swapDisplayedData

clearDisplayedData

restoreDisplayedData