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 (HPS.ContourLineControl in_that): Initializes a control tied to the same object as in_that.

ContourLineControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override void Dispose ()

override HPS.Type ObjectType ()

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).

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

HPS.ContourLineControl SetColors (HPS.RGBColor in_rgb_color)

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

Param in_rgb_color: The color to be used for drawing all contour lines
Return: A reference to this object.

HPS.ContourLineControl SetColors (HPS.RGBColor[] 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.

Param in_colors: An array of colors to be used for drawing contour lines.
Return: A reference to this object.

HPS.ContourLineControl SetLighting (bool in_state)

Controls whether contour lines are lit.

Param in_state: Whether contour lines are lit.
Return: A reference to this object.

HPS.ContourLineControl SetPatterns (string in_pattern)

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

Param in_pattern: The line pattern name, defined in an accessible portfolio, to be used for drawing all contour lines.
Return: A reference to this object.

HPS.ContourLineControl SetPatterns (string[] 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.

Param in_patterns: An array of line pattern names, defined in an accessible portfolio, to be used for drawing contour lines.
Return: A reference to this object.

HPS.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.

Param in_interval: The number of units between contour lines.
Param in_offset: The starting point for contour lines.
Return: A reference to this object.

HPS.ContourLineControl SetPositions (float[] in_positions)

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

Param in_positions: An array of explicit locations to draw contour lines.
Return: A reference to this object.

HPS.ContourLineControl SetVisibility (bool in_state)

Determines whether contour lines should be rendered.

Param in_state: Whether contour lines should be rendered.
Return: A reference to this object.

HPS.ContourLineControl SetWeights (float in_weight)

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

Param in_weight: The line weight to be used for drawing all contour lines.
Return: A reference to this object.

HPS.ContourLineControl SetWeights (float in_weight, HPS.Line.SizeUnits in_units)

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

Param in_weight: The line weight to be used for drawing all contour lines.
Param in_units: The units associated with in_weight.
Return: A reference to this object.

HPS.ContourLineControl SetWeights (float[] in_weights, HPS.Line.SizeUnits[] 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.

Param in_weights: An array of line weights to be applied to contour lines.
Param in_units: An array of line weight units used with the corresponding entry in in_weights.
Return: A reference to this object.

bool ShowColors (out HPS.RGBColor[] out_colors)

Shows the colors of contour lines.

Param out_colors: An array of colors of contour lines
Return: true if the setting is valid, false otherwise.

bool ShowLighting (out bool out_state)

Shows whether contour lines should be lit.

Param out_state: Whether contour lines should be lit.
Return: true if the setting is valid, false otherwise.

bool ShowPatterns (out string[] out_patterns)

bool ShowPositions (out HPS.ContourLine.Mode out_mode, out float[] out_positions)

Shows the positions of contour lines.

Param out_mode: Whether the positions repeat at some interval or are an explicit list.
Param 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.
Return: true if the setting is valid, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility state of contour lines.

Param out_state: Whether contour lines should be rendered.
Return: true if the setting is valid, false otherwise.

bool ShowWeights (out float[] out_weights, out HPS.Line.SizeUnits[] out_units)

Shows the line weights of contour lines.

Param out_weights: An array of line weights for contour lines.
Param out_units: An array of line weight units, each is applied to the corresponding entry in out_weights
Return: true if the setting is valid, false otherwise.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.