PlaceHolderOverlayInfo (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bdv.util.PlaceHolderOverlayInfo

All Implemented Interfaces:: TimePointListener, TransformListener<AffineTransform3D>, ViewerStateChangeListener

public final class PlaceHolderOverlayInfo
extends Object
implements TransformListener<AffineTransform3D>, TimePointListener, ViewerStateChangeListener

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PlaceHolderOverlayInfo.VisibilityChangeListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PlaceHolderOverlayInfo.VisibilityChangeListener`

Constructor Summary

Constructors
Constructor and Description
`PlaceHolderOverlayInfo(ViewerPanel viewer, SourceAndConverter<?> source, ConverterSetup converterSetup)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addVisibilityChangeListener(PlaceHolderOverlayInfo.VisibilityChangeListener listener)` Deprecated. Use `visibilityChangeListeners().add(listener)` instead.
`ARGBType`	`getColor()` Get the color for this converter.
`double`	`getDisplayRangeMax()` Get the (smallest) source value that is mapped to the maximum of the target range.
`double`	`getDisplayRangeMin()` Get the (largest) source value that is mapped to the minimum of the target range.
`int`	`getTimePointIndex()`
`void`	`getViewerTransform(AffineTransform3D t)`
`boolean`	`isVisible()`
`boolean`	`removeVisibilityChangeListener(PlaceHolderOverlayInfo.VisibilityChangeListener listener)` Deprecated. Use `visibilityChangeListeners().remove(listener)` instead.
`void`	`timePointChanged(int timePointIndex)`
`void`	`transformChanged(AffineTransform3D t)`
`void`	`viewerStateChanged(ViewerStateChange change)`
`org.scijava.listeners.Listeners<PlaceHolderOverlayInfo.VisibilityChangeListener>`	`visibilityChangeListeners()` Register `VisibilityChangeListener`s, that will be notified when the visibility of the source represented by this PlaceHolderOverlayInfo changes.

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

- Constructor Detail
  - PlaceHolderOverlayInfo
```
public PlaceHolderOverlayInfo(ViewerPanel viewer,
                              SourceAndConverter<?> source,
                              ConverterSetup converterSetup)
```
    Parameters:
    
    viewer -
    
    source - used for determining visibility.
    
    converterSetup -
- Method Detail
  - transformChanged
```
public void transformChanged(AffineTransform3D t)
```
    Specified by:
    
    transformChanged in interface TransformListener<AffineTransform3D>
  - isVisible
```
public boolean isVisible()
```
  - getViewerTransform
```
public void getViewerTransform(AffineTransform3D t)
```
  - getTimePointIndex
```
public int getTimePointIndex()
```
  - getDisplayRangeMin
```
public double getDisplayRangeMin()
```
    Get the (largest) source value that is mapped to the minimum of the target range.
    
    Returns:
    
    source value that is mapped to the minimum of the target range.
  - getDisplayRangeMax
```
public double getDisplayRangeMax()
```
    Get the (smallest) source value that is mapped to the maximum of the target range.
    
    Returns:
    
    source value that is mapped to the maximum of the target range.
  - getColor
```
public ARGBType getColor()
```
    Get the color for this converter.
    
    Returns:
    
    the color for this converter.
  - timePointChanged
```
public void timePointChanged(int timePointIndex)
```
    Specified by:
    
    timePointChanged in interface TimePointListener
  - viewerStateChanged
```
public void viewerStateChanged(ViewerStateChange change)
```
    Specified by:
    
    viewerStateChanged in interface ViewerStateChangeListener
  - visibilityChangeListeners
```
public org.scijava.listeners.Listeners<PlaceHolderOverlayInfo.VisibilityChangeListener> visibilityChangeListeners()
```
    Register VisibilityChangeListeners, that will be notified when the visibility of the source represented by this PlaceHolderOverlayInfo changes.
  - addVisibilityChangeListener
```
@Deprecated
public boolean addVisibilityChangeListener(PlaceHolderOverlayInfo.VisibilityChangeListener listener)
```
    Deprecated. Use visibilityChangeListeners().add(listener) instead.
    
    Registers a VisibilityChangeListener, that will be notified when the visibility of the source represented by this PlaceHolderOverlayInfo changes.
    
    Parameters:
    
    listener - the listener to register.
    
    Returns:
    
    true if the listener was successfully registered. false if it was already registered.
  - removeVisibilityChangeListener
```
@Deprecated
public boolean removeVisibilityChangeListener(PlaceHolderOverlayInfo.VisibilityChangeListener listener)
```
    Deprecated. Use visibilityChangeListeners().remove(listener) instead.
    
    Removes the specified listener.
    
    Parameters:
    
    listener - the listener to remove.
    
    Returns:
    
    true if the listener was present in the listeners of this model and was successfully removed.

Class PlaceHolderOverlayInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlaceHolderOverlayInfo

Method Detail

transformChanged

isVisible

getViewerTransform

getTimePointIndex

getDisplayRangeMin

getDisplayRangeMax

getColor

timePointChanged

viewerStateChanged

visibilityChangeListeners

addVisibilityChangeListener

removeVisibilityChangeListener