OEColorGradientDisplayOptions¶

class OEColorGradientDisplayOptions

This class represents the OEColorGradientDisplayOptions class that holds properties that determine how a color gradient is rendered.

See also

OEDrawColorGradient function

Constructors¶

OEColorGradientDisplayOptions()

Default constructor.

../../_images/OEColorGradientDisplayOptions_Default.png

Example of drawing a color gradient with default options¶

OEColorGradientDisplayOptions(const OEColorGradientDisplayOptions &rhs)

Copy constructor.

operator=¶

OEColorGradientDisplayOptions &
  operator=(const OEColorGradientDisplayOptions &rhs)

Assignment operator.

AddLabel¶

void AddLabel(const OEColorGradientLabel &label)

Adds an additional label that will be rendered on the strip of the color gradient.

label: The OEColorGradientLabel object that defines the label and the position where the label is going to be rendered to the color gradient.

Example:

opts = OEColorGradientDisplayOptions();
opts.AddLabel(OEColorGradientLabel(-1.0, "dissimilar"));
opts.AddLabel(OEColorGradientLabel(+1.0, "similar"));
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_AddLabel.png

Example of using the AddLabel method¶

See also

OEColorGradientLabel class
OEColorGradientDisplayOptions::GetLabels method
OEColorGradientDisplayOptions::ClearLabels method

AddMarkedValue¶

void AddMarkedValue(double value)

Adds an additional value that will be marked on the strip of the color gradient along with the label of the value above the strip.

Example:

OEColorGradientDisplayOptions opts;
opts.AddMarkedValue(0.20);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_AddMarkedValue.png

Example of using the AddMarkedValue method¶

See also

OEColorGradientDisplayOptions::AddMarkedValues method
OEColorGradientDisplayOptions::GetMarkedValues method
OEColorGradientDisplayOptions::SetMarkedValues method
OEColorGradientDisplayOptions::ClearMarkedValues method

AddMarkedValues¶

void AddMarkedValues(const std::vector<double> &values)

Adds additional values that will be marked on the strip of the color gradient along with their labels above the strip.

Example:

OEColorGradientDisplayOptions opts;
vector<double> markedvalues;
markedvalues.push_back(0.20);
markedvalues.push_back(0.70);
markedvalues.push_back(0.72);
opts.AddMarkedValues(markedvalues);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_AddMarkedValues.png

Example of using the AddMarkedValues method¶

See also

OEColorGradientDisplayOptions::AddMarkedValue method
OEColorGradientDisplayOptions::ClearMarkedValues method
OEColorGradientDisplayOptions::GetMarkedValues method
OEColorGradientDisplayOptions::SetMarkedValues method

ClearBoxRange¶

void ClearBoxRange()

Removes the range previously set to be marked on the color gradient.

See also

OEColorGradientDisplayOptions::SetBoxRange method
OEColorGradientDisplayOptions::GetBoxRangeMax method
OEColorGradientDisplayOptions::GetBoxRangeMin method

ClearLabels¶

void ClearLabels()

Removes labels previously set by the OEColorGradientDisplayOptions::AddLabel method to be marked on the color gradient.

See also

OEColorGradientDisplayOptions::AddLabel method
OEColorGradientDisplayOptions::GetLabels method

ClearMarkedValues¶

void ClearMarkedValues()

Removes any values previously set to be marked on the color gradient.

See also

OEColorGradientDisplayOptions::AddMarkedValue method
OEColorGradientDisplayOptions::AddMarkedValues method
OEColorGradientDisplayOptions::GetMarkedValues method
OEColorGradientDisplayOptions::SetMarkedValues method

GetBoxRangeMax¶

double GetBoxRangeMax() const

Returns the minimum value of the range being marked on the color gradient.

See also

OEColorGradientDisplayOptions::ClearBoxRange method
OEColorGradientDisplayOptions::SetBoxRange method

GetBoxRangeMin¶

double GetBoxRangeMin() const

Returns the maximum value of the range being marked on the color gradient.

See also

OEColorGradientDisplayOptions::ClearBoxRange method
OEColorGradientDisplayOptions::SetBoxRange method

GetBoxRangePen¶

Returns the pen used to draw the box to mark the range set by the OEColorGradientDisplayOptions::SetBoxRange method.

const OEDepict::OEPen &GetBoxRangePen() const

See also

OEPen class
OEColorGradientDisplayOptions::SetBoxRange
OEColorGradientDisplayOptions::SetBoxRangePen method

GetColorStopLabelFont¶

const OEDepict::OEFont &GetColorStopLabelFont() const

Returns the font that is used to render the color stops of the color gradient.

See also

OEFont class
OEColorGradientDisplayOptions::SetColorStopLabelFont method

GetColorStopLabelFontScale¶

double GetColorStopLabelFontScale() const

Returns the multiplier that can be used to increase or decrease the size of the color stop label fonts.

See also

OEColorGradientDisplayOptions::SetColorStopLabelFontScale method

GetColorStopPrecision¶

unsigned int GetColorStopPrecision() const

Returns the precision of the color stop labels i.e. the number of digits that is written to express the floating-point values.

See also

OEColorGradientDisplayOptions::GetColorStopPrecision method

GetColorStopVisibility¶

bool GetColorStopVisibility() const

Returns whether the color stop labels are rendered.

See also

OEColorGradientDisplayOptions::SetColorStopVisibility method

GetLabels¶

OESystem::OEIterBase<OEColorGradientLabel> *GetLabels() const

Returns an iterator over the labels that are being rendered onto the color gradient.

See also

OEColorGradientLabel class
OEColorGradientDisplayOptions::AddLabel method
OEColorGradientDisplayOptions::ClearLabels method

GetMarkedValuePen¶

const OEDepict::OEPen &GetMarkedValuePen() const

Returns the pen that is used to draw the lines for the marked values.

See also

OEPen class
OEColorGradientDisplayOptions::SetMarkedValuePen method

GetMarkedValuePrecision¶

unsigned int GetMarkedValuePrecision() const

Returns the precision of the marked value labels i.e. the number of digits that is written to express the floating-point values.

See also

OEColorGradientDisplayOptions::SetMarkedValuePrecision method

GetMarkedValues¶

OESystem::OEIterBase<double> *GetMarkedValues() const

Returns an iterator over the values that are being marked on the color gradient.

See also

OEColorGradientDisplayOptions::AddMarkedValue method
OEColorGradientDisplayOptions::AddMarkedValues method
OEColorGradientDisplayOptions::ClearMarkedValues method
OEColorGradientDisplayOptions::SetMarkedValues method

SetBoxRange¶

void SetBoxRange(double minvalue, double maxvalue)

Sets the range being marked on the color gradient.

minvalue, maxvalue: The minimum and maximum value of the range.

Example:

OEColorGradientDisplayOptions opts;
opts.SetBoxRange(-0.5, 0.5);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetBoxRange.png

Example of using the SetBoxRange method¶

See also

OEColorGradientDisplayOptions::ClearBoxRange method
OEColorGradientDisplayOptions::GetBoxRangeMax method
OEColorGradientDisplayOptions::GetBoxRangeMin method
OEColorGradientDisplayOptions::SetBoxRange method

SetBoxRangePen¶

void SetBoxRangePen(const OEDepict::OEPen &pen)

Sets the pen used to mark a specified range on the color gradient.

Example:

OEColorGradientDisplayOptions opts;
opts.SetBoxRange(-0.5, 0.5);
OEPen pen(OEBlack, OEBlack, OEFill::On, 2.0, OEStipple::ShortDash);
opts.SetBoxRangePen(pen);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetBoxRangePen.png

Example of using the SetBoxRangePen method¶

See also

OEPen class
OEColorGradientDisplayOptions::GetBoxRangePen method
OEColorGradientDisplayOptions::SetBoxRange method

SetColorStopLabelFont¶

void SetColorStopLabelFont(const OEDepict::OEFont &font)

Sets the font that is used to render color stops of the color gradient.

Example:

OEColorGradientDisplayOptions opts;
OEFont font;
font.SetColor(OEDarkGreen);
font.SetStyle(OEFontStyle::Bold);
opts.SetColorStopLabelFont(font);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetColorStopLabelFont.png

Example of using the SetColorStopLabelFont method¶

Note

The size of font also depends on dimensions of the image into which the color gradient is rendered. See also OEDrawColorGradient function.

See also

OEFont class
OEColorGradientDisplayOptions::GetColorStopLabelFont method

SetColorStopLabelFontScale¶

void SetColorStopLabelFontScale(double scale)

Sets the multiplier that can be used increase or decrease the size of the fonts of the color stop labels.

scale: This value has to be in the range of [0.5, 3.0].

Example:

OEColorGradientDisplayOptions opts;
opts.SetColorStopLabelFontScale(0.5);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetColorStopLabelFontScale.png

Example of using the SetColorStopLabelFontScale method¶

See also

OEColorGradientDisplayOptions::GetColorStopLabelFontScale method
OEColorGradientDisplayOptions::GetColorStopLabelFont method
OEColorGradientDisplayOptions::SetColorStopLabelFont method

SetColorStopPrecision¶

void SetColorStopPrecision(unsigned int precision)

Sets the precision of the color stop labels i.e. the number of digits that is written to express the floating-point values.

precision: The zero value means that the precision is determined by the lowest significant digits of the color stop values that is in the range of [1,4].

Example:

OEColorGradientDisplayOptions opts;
opts.SetColorStopPrecision(4);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetColorStopPrecision.png

Example of using the SetColorStopPrecision method¶

See also

OEColorGradientDisplayOptions::GetColorStopPrecision method

SetColorStopVisibility¶

void SetColorStopVisibility(bool visible)

Sets whether the color stop labels are rendered.

Example:

OEColorGradientDisplayOptions opts;
opts.SetColorStopVisibility(false);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetColorStopVisibility.png

Example of using the SetColorStopVisibility method¶

See also

OEColorGradientDisplayOptions::GetColorStopVisibility method

SetMarkedValuePen¶

void SetMarkedValuePen(const OEDepict::OEPen &pen)

Sets the pen that is used to draw the lines for the marked values.

Example:

OEColorGradientDisplayOptions opts;
vector<double> markedvalues;
markedvalues.push_back(0.20);
markedvalues.push_back(0.70);
markedvalues.push_back(0.72);
OEPen pen(OEBlack, OEDarkGreen, OEFill::On, 2.0, OEStipple::ShortDash);
opts.SetMarkedValuePen(pen);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetMarkedValuePen.png

Example of using the SetMarkedValuePen method¶

See also

OEPen class
OEColorGradientDisplayOptions::GetMarkedValuePen method

SetMarkedValuePrecision¶

void SetMarkedValuePrecision(unsigned int precision)

Sets the precision of the marked value labels i.e. the number of digits that is written to express the floating-point values. Decreasing the precision can result in collapsing that labels of two or more distinct values into one label.

Example:

OEColorGradientDisplayOptions opts;
vector<double> markedvalues;
markedvalues.push_back(0.20);
markedvalues.push_back(0.70);
markedvalues.push_back(0.72);
opts.SetMarkedValuePrecision(1);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetMarkedValuePrecision.png

Example of using the SetMarkedValuePrecision method¶

See also

OEColorGradientDisplayOptions::GetMarkedValuePrecision method

SetMarkedValues¶

void SetMarkedValues(const std::vector<double> &values)

Initializes values that will be marked on the strip of the color gradient along with the value labels above the strip. OEColorGradientDisplayOptions::SetMarkedValues method discards the list of values set in prior calls.

Example:

OEColorGradientDisplayOptions opts;
opts.AddMarkedValue(0.0);
vector<double> markedvalues;
markedvalues.push_back(0.75);
markedvalues.push_back(0.50);
opts.SetMarkedValues(markedvalues);
OEDrawColorGradient(image, colorg, opts);

../../_images/OEColorGradientDisplayOptions_SetMarkedValues.png

Example of using the SetMarkedValues method¶

See also

OEColorGradientDisplayOptions::AddMarkedValue method
OEColorGradientDisplayOptions::AddMarkedValues method
OEColorGradientDisplayOptions::ClearMarkedValues method