Module org.bigdataviewer.core

Package bdv.util

Class BoundedIntervalDouble

java.lang.Object

bdv.util.BoundedIntervalDouble

Direct Known Subclasses:

MinMaxGroup

public class BoundedIntervalDouble
extends Object

A interval consisting of BoundedValueDouble minimum and maximum that can span any interval in a given range. The UI can listen to changes by adding listeners can attach to the minimum and maximum values and/or overriding the updateInterval(double, double) method.

Author:

Tobias Pietzsch

Field Summary

Fields

Modifier and Type	Field	Description
protected double	minIntervalSize	minimum interval size.

Constructor Summary

Constructors

Constructor	Description
BoundedIntervalDouble(double rangeMin, double rangeMax, double initialMin, double initialMax, double minIntervalSize)

Method Summary

Modifier and Type	Method	Description
BoundedValueDouble	getMaxBoundedValue()	Get the current maximum of the interval.
BoundedValueDouble	getMinBoundedValue()	Get the current minimum of the interval.
double	getRangeMax()	Get the current maximum of the allowed range.
double	getRangeMin()	Get the current minimum of the allowed range.
void	setRange(double min, double max)	Set the allowed range.
protected void	updateInterval(double min, double max)	This is called when the min or max values change.

Methods inherited from class java.lang.Object

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

Field Detail

minIntervalSize

protected final double minIntervalSize

minimum interval size. max - min >= minIntervalSize.

Constructor Detail

BoundedIntervalDouble

public BoundedIntervalDouble(double rangeMin,
                             double rangeMax,
                             double initialMin,
                             double initialMax,
                             double minIntervalSize)

Parameters:

rangeMin - lower bound of the allowed range. the interval minimum cannot be lower than this.

rangeMax - upper bound of the allowed range. the interval maximum cannot be lower than this.

initialMin - initial interval minimum.

initialMax - initial interval maximum.

minIntervalSize - interval is forced to have this size at least, i.e., max - min >= minIntervalSize.

Method Detail

updateInterval

protected void updateInterval(double min,
                              double max)

This is called when the min or max values change. The default implementation does nothing but derived classes can use it to trigger UI updates, etc.

Parameters:

min - the new minimum of the interval

max - the new maximum of the interval

getMinBoundedValue

public BoundedValueDouble getMinBoundedValue()

Get the current minimum of the interval.

Returns:

the current minimum of the interval.

getMaxBoundedValue

public BoundedValueDouble getMaxBoundedValue()

Get the current maximum of the interval.

Returns:

the current maximum of the interval.

getRangeMin

public double getRangeMin()

Get the current minimum of the allowed range. (The interval ( getMinBoundedValue(), getMaxBoundedValue()) is be a non-empty interval within the allowed range.)

Returns:

the current minimum of the allowed range.

getRangeMax

public double getRangeMax()

Get the current maximum of the allowed range. (The interval ( getMinBoundedValue(), getMaxBoundedValue()) is be a non-empty interval within the allowed range.)

Returns:

the current maximum of the allowed range.

setRange

public void setRange(double min,
                     double max)

Set the allowed range. The interval (getMinBoundedValue(), getMaxBoundedValue()) is enforced to be a non-empty interval within the allowed range.

Parameters:

min - minimum of the allowed range.

max - maximum of the allowed range.