ContourLineControl

class HPS::ContourLineControl : public HPS::Control

The HPS::ContourLineControl class is a smart pointer that is tied to a database object. As its name suggests, this object can be used to control the various attributes related to contour lines, such as pattern, position, color, and weight. This table lists default values for the various segment attributes accessible from HPS::ContourLineControl.

Public Functions

ContourLineControl(ContourLineControl &&in_that)

The move constructor creates a ContourLineControl by transferring the underlying impl of the rvalue reference to this ContourLineControl thereby avoiding a copy and allocation.

Parameters

in_that – An rvalue reference to a ContourLineControl to take the impl from.

ContourLineControl(ContourLineControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit ContourLineControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

ContourLineControl &operator=(ContourLineControl &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ContourLineControl thereby avoiding a copy.

Parameters

in_that – An rvalue reference to a ContourLineControl to take the impl from.

Returns

A reference to this ContourLineControl.

ContourLineControl &operator=(ContourLineControl const &in_that)

Share the underlying smart-pointer of the ContourLineControl source.

Parameters

in_that – The ContourLineControl source of the assignment.

Returns

A reference to this ContourLineControl.

ContourLineControl &SetColors(RGBColor const &in_rgb_color)

Sets the color to be used for drawing all contour lines.

Parameters

in_rgb_color – The color to be used for drawing all contour lines

Returns

A reference to this object.

ContourLineControl &SetColors(RGBColorArray const &in_colors)

Sets the colors to be used for drawing contour lines. If there are more contour lines than colors, the array will be cycled through.

Parameters

in_colors – An array of colors to be used for drawing contour lines.

Returns

A reference to this object.

ContourLineControl &SetColors(size_t in_count, RGBColor const in_colors[])

Sets the colors to be used for drawing contour lines. If there are more contour lines than colors, the array will be cycled through.

Parameters

  • in_count – The number of elements in in_colors.

  • in_colors – An array of colors to be used for drawing contour lines.

Returns

A reference to this object.

ContourLineControl &SetLighting(bool in_state)

Controls whether contour lines are lit.

Parameters

in_state – Whether contour lines are lit.

Returns

A reference to this object.

ContourLineControl &SetPatterns(char const *in_pattern)

Sets the line pattern to be used for drawing all contour lines.

Parameters

in_pattern – The line pattern name, defined in an accessible portfolio, to be used for drawing all contour lines.

Returns

A reference to this object.

ContourLineControl &SetPatterns(size_t in_count, UTF8 const in_patterns[])

Sets the line patterns to be used for drawing contour lines. If there are more contour lines than patterns, the array will be cycled through.

Parameters

  • in_count – The number of elements in in_patterns.

  • in_patterns – An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines.

Returns

A reference to this object.

ContourLineControl &SetPatterns(UTF8Array const &in_patterns)

Sets the line patterns to be used for drawing contour lines. If there are more contour lines than patterns, the array will be cycled through.

Parameters

in_patterns – An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines.

Returns

A reference to this object.

ContourLineControl &SetPositions(float in_interval, float in_offset)

Controls the positioning of contour lines. This variant creates them at regular intervals with an optional offset.

Parameters

  • in_interval – The number of units between contour lines.

  • in_offset – The starting point for contour lines.

Returns

A reference to this object.

ContourLineControl &SetPositions(FloatArray const &in_positions)

Controls the positioning of contour lines. This variant defines explicit locations that contour lines should appear at.

Parameters

in_positions – An array of explicit locations to draw contour lines.

Returns

A reference to this object.

ContourLineControl &SetPositions(size_t in_count, float const in_positions[])

Controls the positioning of contour lines. This variant defines explicit locations that contour lines should appear at.

Parameters

  • in_count – The number of elements in in_positions.

  • in_positions – An array of explicit locations to draw contour lines.

Returns

A reference to this object.

ContourLineControl &SetVisibility(bool in_state)

Determines whether contour lines should be rendered.

Parameters

in_state – Whether contour lines should be rendered.

Returns

A reference to this object.

ContourLineControl &SetWeights(float in_weight, Line::SizeUnits in_units = Line::SizeUnits::ScaleFactor)

Sets the line weight to be used for drawing all contour lines.

Parameters

  • in_weight – The line weight to be used for drawing all contour lines.

  • in_units – The units associated with in_weight.

Returns

A reference to this object.

ContourLineControl &SetWeights(FloatArray const &in_weights, LineSizeUnitsArray const &in_units)

Sets the line weights to be used for drawing contour lines. If there are more contour lines than weights, the array will be cycled through.

Parameters

  • in_weights – An array of line weights to be applied to contour lines.

  • in_units – An array of line weight units used with the corresponding entry in in_weights.

Returns

A reference to this object.

ContourLineControl &SetWeights(size_t in_count, float const in_weights[], Line::SizeUnits const in_units[])

Sets the line weights to be used for drawing contour lines. If there are more contour lines than weights, the array will be cycled through.

Parameters

  • in_count – The number of elements in both in_weights and in_units.

  • in_weights – An array of line weights to be applied to contour lines.

  • in_units – An array of line weight units used with the corresponding entry in in_weights.

Returns

A reference to this object.

bool ShowColors(RGBColorArray &out_colors) const

Shows the colors of contour lines.

Parameters

out_colors – An array of colors of contour lines

Returns

true if the setting is valid, false otherwise.

bool ShowLighting(bool &out_state) const

Shows whether contour lines should be lit.

Parameters

out_state – Whether contour lines should be lit.

Returns

true if the setting is valid, false otherwise.

bool ShowPatterns(UTF8Array &out_patterns) const

Shows the line patterns of contour lines.

Parameters

out_patterns – An array of line pattern names for contour lines.

Returns

true if the setting is valid, false otherwise.

bool ShowPositions(ContourLine::Mode &out_mode, FloatArray &out_positions) const

Shows the positions of contour lines.

Parameters

  • out_mode – Whether the positions repeat at some interval or are an explicit list.

  • out_positions – If out_mode is Repeating, this will contain the interval and offset, in that order. Otherwise it will contain the explicit list specified.

Returns

true if the setting is valid, false otherwise.

bool ShowVisibility(bool &out_state) const

Shows the visibility state of contour lines.

Parameters

out_state – Whether contour lines should be rendered.

Returns

true if the setting is valid, false otherwise.

bool ShowWeights(FloatArray &out_weights, LineSizeUnitsArray &out_units) const

Shows the line weights of contour lines.

Parameters

  • out_weights – An array of line weights for contour lines.

  • out_units – An array of line weight units, each is applied to the corresponding entry in out_weights

Returns

true if the setting is valid, false otherwise.

ContourLineControl &UnsetColors()

Removes the contour line colors setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetEverything()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetLighting()

Removes the contour line lighting setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetPatterns()

Removes the contour line patterns setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetPositions()

Removes the contour line positions setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetVisibility()

Removes the contour line visibility setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

ContourLineControl &UnsetWeights()

Removes the contour line weights setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by ContourLineKit::GetDefault().

Returns

A reference to this object.

~ContourLineControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ContourLineControl