Package adams.data.objectfilter

Class Scale

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFilter, FlowContextHandler, Serializable
    public class Scale
extends AbstractObjectFilter
    Scales the objects. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -scale-x <double> (property: scaleX)
    The factor for scaling x/width.
    default: 1.0
    minimum: 0.0
 
    -scale-y <double> (property: scaleY)
    The factor for scaling y/width.
    default: 1.0
    minimum: 0.0
 
    -round <boolean> (property: round)
    If enabled, the scaled values get round.
    default: false
 
    -rounding-type <ROUND|CEILING|FLOOR> (property: roundingType)
    The type of rounding to perform.
    default: ROUND
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ScaleX

        protected double m_ScaleX
        the scale factor for x/width.

      • m_ScaleY

        protected double m_ScaleY
        the scale factor for y/height.

      • m_Round

        protected boolean m_Round
        whether to round the scaled values.

      • m_RoundingType

        protected RoundingType m_RoundingType
        the rounding type.

      • m_NumDecimals

        protected int m_NumDecimals
        the number of decimals.

    • Constructor Detail

      • Scale

        public Scale()

    • Method Detail

      • setScaleX

        public void setScaleX​(double value)
        Sets the scale factor for x/width.
        Parameters:
        value - the factor

      • getScaleX

        public double getScaleX()
        Returns the scale factor for x/width.
        Returns:
        the factor

      • scaleXTipText

        public String scaleXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setScaleY

        public void setScaleY​(double value)
        Sets the scale factor for y/width.
        Parameters:
        value - the factor

      • getScaleY

        public double getScaleY()
        Returns the scale factor for y/width.
        Returns:
        the factor

      • scaleYTipText

        public String scaleYTipText()
        Returns the tip teyt for this property.
        Returns:
        tip teyt for this property suitable for displaying in the GUI or for listing the options.

      • setRound

        public void setRound​(boolean value)
        Sets whether to round the scaled values.
        Parameters:
        value - true if to round

      • getRound

        public boolean getRound()
        Returns whether to round the scaled values.
        Returns:
        true if to round

      • roundTipText

        public String roundTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRoundingType

        public void setRoundingType​(RoundingType value)
        Sets the type of rounding to perform.
        Parameters:
        value - the type

      • getRoundingType

        public RoundingType getRoundingType()
        Returns the type of rounding to perform.
        Returns:
        the type

      • roundingTypeTipText

        public String roundingTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumDecimals

        public void setNumDecimals​(int value)
        Sets the number of decimals after the decimal point to use.
        Parameters:
        value - the number of decimals

      • getNumDecimals

        public int getNumDecimals()
        Returns the number of decimals after the decimal point to use.
        Returns:
        the number of decimals

      • numDecimalsTipText

        public String numDecimalsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • round

        protected double round​(double value)
        Rounds the value according to the parameters.
        Parameters:
        value - the value to round
        Returns:
        the potentially rounded value
        See Also:
        m_Round, m_RoundingType