com.tensegrity.composite.coordinate
Interface MutableScale

All Superinterfaces:

Scale

All Known Subinterfaces:

MutableCategoryScale

All Known Implementing Classes:

DefaultMutableCategoryScale, DefaultMutableScaleLinear, DefaultMutableTableCellCategoryScale

public interface MutableScale

extends Scale

The MutableScale is a specialization of the Scale interface. Therefore it is neccessary to read the documentation of the Scale interface to have an understanding of the basics for a Scale.

Since a Scale is immutable but mutable scales are also needed this class represents such an MutableScale.

In contrast to a Scale for a MutableScale it is possible to modify the minimum scale value, the maximum scale value and the complete scale range. The methods a MutableScale provides to do so are as follows:

• setScaleMinimum(double)
• setScaleMaximum(double)
• setScaleRange(double, double)

Notice that instances of MutableScale are not part of the pooling mechanism for Scales.

Version:

$Id: MutableScale.java,v 1.5 2005/04/01 15:45:16 MichaelKegel Exp $

Author:

MichaelKegel

Field Summary

Fields inherited from interface com.tensegrity.composite.coordinate.Scale

TYPE_LINEAR

Method Summary

void	setScaleMaximum(double maximumScale) Sets the maximum value for this scale.
void	setScaleMinimum(double minimumScale) Sets the minimum value for this scale.
void	setScaleRange(double minimumScale, double maximumScale) Sets the range of this scale by specifying a minumum and a maximum value.

Methods inherited from interface com.tensegrity.composite.coordinate.Scale

deepCopy, descale, getDescaleFactor, getScaleFactor, getScaleMaximum, getScaleMinimum, getScaleRange, scale

Method Detail

setScaleMinimum

public void setScaleMinimum(double minimumScale)

Sets the minimum value for this scale.

Parameters:

minimumScale - the value ti set as a minimum.

setScaleMaximum

public void setScaleMaximum(double maximumScale)

Sets the maximum value for this scale.

Parameters:

maximumScale - the value ti set as a maximum.

setScaleRange

public void setScaleRange(double minimumScale,
                          double maximumScale)

Sets the range of this scale by specifying a minumum and a maximum value.

Parameters:

minimumScale - the minimum value for this scale.

maximumScale - the maximum value for this scale.