ColorFilterSettings Class Reference

Color filter parameters for one curve. For a class, this is handled the same as LineStyle and PointStyle. More...

#include <ColorFilterSettings.h>

Collaboration diagram for ColorFilterSettings:

Public Member Functions
	ColorFilterSettings ()
	Default constructor only for use when this class is being stored by a container that requires the default constructor.
	ColorFilterSettings (ColorFilterMode colorFilterMode, int intensityLow, int intensityHigh, int foregroundLow, int foregroundHigh, int hueLow, int hueHigh, int saturationLow, int saturationHigh, int valueLow, int valueHigh)
	Normal constructor. The style type and radius are determined by the currently selected Curve.
	ColorFilterSettings (const ColorFilterSettings &other)
	Copy constructor.
	ColorFilterSettings (QXmlStreamReader &reader)
	Constructor when loading from serialized xml.
ColorFilterSettings &	operator= (const ColorFilterSettings &other)
	Assignment operator.
	~ColorFilterSettings ()
	Destructor deallocates memory.
ColorFilterMode	colorFilterMode () const
	Get method for filter mode.
int	foregroundHigh () const
	Get method for foreground higher bound.
int	foregroundLow () const
	Get method for foreground lower bound.
double	high () const
	High value of foreground, hue, intensity, saturation or value according to current filter mode, normalized to 0 to 1.
int	hueHigh () const
	Get method for hue higher bound.
int	hueLow () const
	Get method for hue lower bound.
int	intensityHigh () const
	Get method for intensity higher bound.
int	intensityLow () const
	Get method for intensity lower bound.
void	loadXml (QXmlStreamReader &reader)
	Load curve filter to stream.
double	low () const
	Low value of foreground, hue, intensity, saturation or value according to current filter mode, normalized to 0 to 1.
void	printStream (QString indentation, QTextStream &str) const
	Debugging method that supports print method of this class and printStream method of some other class(es).
int	saturationHigh () const
	Get method for saturation higher bound.
int	saturationLow () const
	Get method for saturation lower bound.
void	saveXml (QXmlStreamWriter &writer, const QString &curveName) const
	Save curve filter to stream.
void	setColorFilterMode (ColorFilterMode colorFilterMode)
	Set method for filter mode.
void	setForegroundHigh (int foregroundHigh)
	Set method for foreground higher bound.
void	setForegroundLow (int foregroundLow)
	Set method for foreground lower bound.
void	setHigh (double s0To1)
	Set the high value for the current filter mode.
void	setHueHigh (int hueHigh)
	Set method for hue higher bound.
void	setHueLow (int hueLow)
	Set method for hue lower bound.
void	setIntensityHigh (int intensityHigh)
	Set method for intensity higher bound.
void	setIntensityLow (int intensityLow)
	Set method for intensity lower bound.
void	setLow (double s0To1)
	Set the low value for the current filter mode.
void	setSaturationHigh (int saturationHigh)
	Set method for saturation high.
void	setSaturationLow (int saturationLow)
	Set method for saturation low.
void	setValueHigh (int valueHigh)
	Set method for value high.
void	setValueLow (int valueLow)
	Set method for value low.
int	valueHigh () const
	Get method for value high.
int	valueLow () const
	Get method for value low.

Static Public Member Functions
static ColorFilterSettings	defaultFilter ()
	Initial default for any Curve.

Detailed Description

Color filter parameters for one curve. For a class, this is handled the same as LineStyle and PointStyle.

Definition at line 19 of file ColorFilterSettings.h.

Constructor & Destructor Documentation

ColorFilterSettings() [1/4]

ColorFilterSettings::ColorFilterSettings

(

)

Default constructor only for use when this class is being stored by a container that requires the default constructor.

Definition at line 24 of file ColorFilterSettings.cpp.

                                         :
  m_colorFilterMode (COLOR_FILTER_MODE_INTENSITY),
  m_intensityLow (INTENSITY_LOW_DEFAULT),
  m_intensityHigh (INTENSITY_HIGH_DEFAULT),
  m_foregroundLow (FOREGROUND_LOW_DEFAULT),
  m_foregroundHigh (FOREGROUND_HIGH_DEFAULT),
  m_hueLow (HUE_LOW_DEFAULT),
  m_hueHigh (HUE_HIGH_DEFAULT),
  m_saturationLow (SATURATION_LOW_DEFAULT),
  m_saturationHigh (SATURATION_HIGH_DEFAULT),
  m_valueLow (VALUE_LOW_DEFAULT),
  m_valueHigh (VALUE_HIGH_DEFAULT)
{
  createStrategies ();
}

ColorFilterSettings() [2/4]

ColorFilterSettings::ColorFilterSettings	(	ColorFilterMode	colorFilterMode,
		int	intensityLow,
		int	intensityHigh,
		int	foregroundLow,
		int	foregroundHigh,
		int	hueLow,
		int	hueHigh,
		int	saturationLow,
		int	saturationHigh,
		int	valueLow,
		int	valueHigh )

Normal constructor. The style type and radius are determined by the currently selected Curve.

Definition at line 40 of file ColorFilterSettings.cpp.

                                                        :
  m_colorFilterMode (colorFilterMode),
  m_intensityLow (intensityLow),
  m_intensityHigh (intensityHigh),
  m_foregroundLow (foregroundLow),
  m_foregroundHigh (foregroundHigh),
  m_hueLow (hueLow),
  m_hueHigh (hueHigh),
  m_saturationLow (saturationLow),
  m_saturationHigh (saturationHigh),
  m_valueLow (valueLow),
  m_valueHigh (valueHigh)
{
  createStrategies ();
}

ColorFilterSettings() [3/4]

ColorFilterSettings::ColorFilterSettings

(

const ColorFilterSettings &

other

)

Copy constructor.

Definition at line 66 of file ColorFilterSettings.cpp.

                                                                         :
  m_colorFilterMode (other.colorFilterMode()),
  m_intensityLow (other.intensityLow()),
  m_intensityHigh (other.intensityHigh()),
  m_foregroundLow (other.foregroundLow()),
  m_foregroundHigh (other.foregroundHigh()),
  m_hueLow (other.hueLow()),
  m_hueHigh (other.hueHigh()),
  m_saturationLow (other.saturationLow()),
  m_saturationHigh (other.saturationHigh()),
  m_valueLow (other.valueLow()),
  m_valueHigh (other.valueHigh())
{
  createStrategies ();
}

ColorFilterSettings() [4/4]

ColorFilterSettings::ColorFilterSettings

(

QXmlStreamReader &

reader

)

Constructor when loading from serialized xml.

Definition at line 82 of file ColorFilterSettings.cpp.

{
  loadXml(reader);
  createStrategies ();
}

~ColorFilterSettings()

ColorFilterSettings::~ColorFilterSettings

(

)

Destructor deallocates memory.

Definition at line 107 of file ColorFilterSettings.cpp.

{
  qDeleteAll (m_strategies);
}

Member Function Documentation

colorFilterMode()

ColorFilterMode ColorFilterSettings::colorFilterMode

(

)

const

Get method for filter mode.

Definition at line 112 of file ColorFilterSettings.cpp.

{
  return m_colorFilterMode;
}

defaultFilter()

ColorFilterSettings ColorFilterSettings::defaultFilter ( )

static

Initial default for any Curve.

Definition at line 128 of file ColorFilterSettings.cpp.

{
  return ColorFilterSettings ();
}

foregroundHigh()

int ColorFilterSettings::foregroundHigh

(

)

const

Get method for foreground higher bound.

Definition at line 133 of file ColorFilterSettings.cpp.

{
  return m_foregroundHigh;
}

foregroundLow()

int ColorFilterSettings::foregroundLow

(

)

const

Get method for foreground lower bound.

Definition at line 138 of file ColorFilterSettings.cpp.

{
  return m_foregroundLow;
}

high()

double ColorFilterSettings::high

(

)

const

High value of foreground, hue, intensity, saturation or value according to current filter mode, normalized to 0 to 1.

Definition at line 143 of file ColorFilterSettings.cpp.

{
  if (m_strategies.contains (m_colorFilterMode)) {
 
    // Ignore false positive cmake compiler warning about -Wreturn-stack-address in next line (bug #26396)
    const ColorFilterSettingsStrategyAbstractBase *strategy = m_strategies.value (m_colorFilterMode);
    return strategy->high (*this);
  } else {
    LOG4CPP_ERROR_S ((*mainCat)) << "ColorFilterSettings::high is missing color filter mode";
    ENGAUGE_ASSERT (false);
    return m_strategies [COLOR_FILTER_MODE_INTENSITY]->high (*this);
  }
}

hueHigh()

int ColorFilterSettings::hueHigh

(

)

const

Get method for hue higher bound.

Definition at line 157 of file ColorFilterSettings.cpp.

{
  return m_hueHigh;
}

hueLow()

int ColorFilterSettings::hueLow

(

)

const

Get method for hue lower bound.

Definition at line 162 of file ColorFilterSettings.cpp.

{
  return m_hueLow;
}

intensityHigh()

int ColorFilterSettings::intensityHigh

(

)

const

Get method for intensity higher bound.

Definition at line 167 of file ColorFilterSettings.cpp.

{
  return m_intensityHigh;
}

intensityLow()

int ColorFilterSettings::intensityLow

(

)

const

Get method for intensity lower bound.

Definition at line 172 of file ColorFilterSettings.cpp.

{
  return m_intensityLow;
}

loadXml()

void ColorFilterSettings::loadXml

(

QXmlStreamReader &

reader

)

Load curve filter to stream.

Definition at line 177 of file ColorFilterSettings.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "ColorFilterSettings::loadXml";
 
  bool success = true;
 
  QXmlStreamAttributes attributes = reader.attributes();
 
  if (attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_MODE) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_LOW) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_HIGH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_LOW) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_HIGH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_LOW) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_HIGH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_LOW) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_HIGH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_LOW) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_HIGH)) {
 
    setColorFilterMode (static_cast<ColorFilterMode> (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_MODE).toInt()));
    setIntensityLow (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_LOW).toInt());
    setIntensityHigh (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_HIGH).toInt()));
    setForegroundLow (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_LOW).toInt());
    setForegroundHigh (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_HIGH).toInt());
    setHueLow (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_LOW).toInt());
    setHueHigh (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_HIGH).toInt());
    setSaturationLow (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_LOW).toInt()));
    setSaturationHigh (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_HIGH).toInt());
    setValueLow (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_LOW).toInt());
    setValueHigh (attributes.value(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_HIGH).toInt());
 
    // Read until end of this subtree
    while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
    (reader.name() != DOCUMENT_SERIALIZE_COLOR_FILTER)){
      loadNextFromReader(reader);
 
      if (reader.atEnd()) {
        success = false;
        break;
      }
    }
  }
 
  if (!success) {
    reader.raiseError (QObject::tr ("Cannot read curve filter data"));
  }
}

low()

double ColorFilterSettings::low

(

)

const

Low value of foreground, hue, intensity, saturation or value according to current filter mode, normalized to 0 to 1.

Definition at line 226 of file ColorFilterSettings.cpp.

{
  if (m_strategies.contains (m_colorFilterMode)) {
    const ColorFilterSettingsStrategyAbstractBase *strategy = m_strategies.value (m_colorFilterMode);
    return strategy->low (*this);
  } else {
    LOG4CPP_ERROR_S ((*mainCat)) << "ColorFilterSettings::low is missing color filter mode";
    ENGAUGE_ASSERT (false);
    return m_strategies [COLOR_FILTER_MODE_INTENSITY]->low (*this);
  }
}

operator=()

ColorFilterSettings & ColorFilterSettings::operator=

(

const ColorFilterSettings &

other

)

Assignment operator.

Definition at line 88 of file ColorFilterSettings.cpp.

{
  m_colorFilterMode = other.colorFilterMode();
  m_intensityLow = other.intensityLow();
  m_intensityHigh = other.intensityHigh();
  m_foregroundLow = other.foregroundLow();
  m_foregroundHigh = other.foregroundHigh();
  m_hueLow = other.hueLow();
  m_hueHigh = other.hueHigh();
  m_saturationLow = other.saturationLow();
  m_saturationHigh = other.saturationHigh();
  m_valueLow = other.valueLow();
  m_valueHigh = other.valueHigh();
 
  createStrategies ();
 
  return *this;
}

printStream()

void ColorFilterSettings::printStream	(	QString	indentation,
		QTextStream &	str ) const

Debugging method that supports print method of this class and printStream method of some other class(es).

Definition at line 238 of file ColorFilterSettings.cpp.

{
  str << indentation << "ColorFilterSettings\n";
 
  indentation += INDENTATION_DELTA;
 
  if (m_strategies.contains (m_colorFilterMode)) {
    const ColorFilterSettingsStrategyAbstractBase *strategy = m_strategies.value (m_colorFilterMode);
    return strategy->printStream (*this,
                                  indentation,
                                  str);
  }
}

saturationHigh()

int ColorFilterSettings::saturationHigh

(

)

const

Get method for saturation higher bound.

Definition at line 253 of file ColorFilterSettings.cpp.

{
  return m_saturationHigh;
}

saturationLow()

int ColorFilterSettings::saturationLow

(

)

const

Get method for saturation lower bound.

Definition at line 258 of file ColorFilterSettings.cpp.

{
  return m_saturationLow;
}

saveXml()

void ColorFilterSettings::saveXml	(	QXmlStreamWriter &	writer,
		const QString &	curveName ) const

Save curve filter to stream.

Definition at line 263 of file ColorFilterSettings.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "ColorFilterSettings::saveXml";
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_COLOR_FILTER);
  writer.writeAttribute(DOCUMENT_SERIALIZE_CURVE_NAME, curveName);
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_MODE, QString::number (m_colorFilterMode));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_MODE_STRING, colorFilterModeToString (m_colorFilterMode));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_LOW, QString::number (m_intensityLow));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_INTENSITY_HIGH, QString::number (m_intensityHigh));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_LOW, QString::number (m_foregroundLow));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_FOREGROUND_HIGH, QString::number (m_foregroundHigh));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_LOW, QString::number (m_hueLow));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_HUE_HIGH, QString::number (m_hueHigh));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_LOW, QString::number (m_saturationLow));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_SATURATION_HIGH, QString::number (m_saturationHigh));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_LOW, QString::number (m_valueLow));
  writer.writeAttribute(DOCUMENT_SERIALIZE_COLOR_FILTER_VALUE_HIGH, QString::number (m_valueHigh));
  writer.writeEndElement();
}

setColorFilterMode()

void ColorFilterSettings::setColorFilterMode

(

ColorFilterMode

colorFilterMode

)

Set method for filter mode.

Definition at line 285 of file ColorFilterSettings.cpp.

{
  m_colorFilterMode = colorFilterMode;
}

setForegroundHigh()

void ColorFilterSettings::setForegroundHigh

(

int

foregroundHigh

)

Set method for foreground higher bound.

Definition at line 290 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (FOREGROUND_MIN <= foregroundHigh && foregroundHigh <= FOREGROUND_MAX);
  m_foregroundHigh = foregroundHigh;
}

setForegroundLow()

void ColorFilterSettings::setForegroundLow

(

int

foregroundLow

)

Set method for foreground lower bound.

Definition at line 296 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (FOREGROUND_MIN <= foregroundLow && foregroundLow <= FOREGROUND_MAX);
  m_foregroundLow = foregroundLow;
}

setHigh()

void ColorFilterSettings::setHigh

(

double

s0To1

)

Set the high value for the current filter mode.

Definition at line 302 of file ColorFilterSettings.cpp.

{
  if (m_strategies.contains (m_colorFilterMode)) {
    ColorFilterSettingsStrategyAbstractBase *strategy = m_strategies [m_colorFilterMode];
    return strategy->setHigh (*this,
                              s0To1);
  } else {
    LOG4CPP_ERROR_S ((*mainCat)) << "ColorFilterSettings::setHigh is missing color filter mode";
    ENGAUGE_ASSERT (false);
  }
}

setHueHigh()

void ColorFilterSettings::setHueHigh

(

int

hueHigh

)

Set method for hue higher bound.

Definition at line 314 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (HUE_MIN <= hueHigh && hueHigh <= HUE_MAX);
  m_hueHigh = hueHigh;
}

setHueLow()

void ColorFilterSettings::setHueLow

(

int

hueLow

)

Set method for hue lower bound.

Definition at line 320 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (HUE_MIN <= hueLow && hueLow <= HUE_MAX);
  m_hueLow = hueLow;
}

setIntensityHigh()

void ColorFilterSettings::setIntensityHigh

(

int

intensityHigh

)

Set method for intensity higher bound.

Definition at line 326 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (INTENSITY_MIN <= intensityHigh && intensityHigh <= INTENSITY_MAX);
  m_intensityHigh = intensityHigh;
}

setIntensityLow()

void ColorFilterSettings::setIntensityLow

(

int

intensityLow

)

Set method for intensity lower bound.

Definition at line 332 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (INTENSITY_MIN <= intensityLow && intensityLow <= INTENSITY_MAX);
  m_intensityLow = intensityLow;
}

setLow()

void ColorFilterSettings::setLow

(

double

s0To1

)

Set the low value for the current filter mode.

Definition at line 338 of file ColorFilterSettings.cpp.

{
  if (m_strategies.contains (m_colorFilterMode)) {
    ColorFilterSettingsStrategyAbstractBase *strategy = m_strategies [m_colorFilterMode];
    return strategy->setLow (*this,
                             s0To1);
  } else {
    LOG4CPP_ERROR_S ((*mainCat)) << "ColorFilterSettings::setLow is missing color filter mode";
    ENGAUGE_ASSERT (false);
  }
}

setSaturationHigh()

void ColorFilterSettings::setSaturationHigh

(

int

saturationHigh

)

Set method for saturation high.

Definition at line 350 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (SATURATION_MIN <= saturationHigh && saturationHigh <= SATURATION_MAX);
  m_saturationHigh = saturationHigh;
}

setSaturationLow()

void ColorFilterSettings::setSaturationLow

(

int

saturationLow

)

Set method for saturation low.

Definition at line 356 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (SATURATION_MIN <= saturationLow && saturationLow <= SATURATION_MAX);
  m_saturationLow = saturationLow;
}

setValueHigh()

void ColorFilterSettings::setValueHigh

(

int

valueHigh

)

Set method for value high.

Definition at line 362 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (VALUE_MIN <= valueHigh && valueHigh <= VALUE_MAX);
  m_valueHigh = valueHigh;
}

setValueLow()

void ColorFilterSettings::setValueLow

(

int

valueLow

)

Set method for value low.

Definition at line 368 of file ColorFilterSettings.cpp.

{
  ENGAUGE_ASSERT (VALUE_MIN <= valueLow && valueLow <= VALUE_MAX);
  m_valueLow = valueLow;
}

valueHigh()

int ColorFilterSettings::valueHigh

(

)

const

Get method for value high.

Definition at line 374 of file ColorFilterSettings.cpp.

{
  return m_valueHigh;
}

valueLow()

int ColorFilterSettings::valueLow

(

)

const

Get method for value low.

Definition at line 379 of file ColorFilterSettings.cpp.

{
  return m_valueLow;
}

---

The documentation for this class was generated from the following files:

• Color/ColorFilterSettings.h
• Color/ColorFilterSettings.cpp