ContourLineKit

class HPS.ContourLineKit : public HPS.Kit 

The HPS.ContourLineKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS.ContourLineKit.GetDefault() will return a kit with values found in this table.

Public Functions

ContourLineKit (): Initializes an empty kit.

ContourLineKit (HPS.ContourLineKit in_kit)

The copy constructor creates a new ContourLineKit object that contains the same settings as the source object.

Param in_kit: The source object to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return: true if no values are set on this object, false otherwise.

bool Equals (HPS.ContourLineKit in_kit)

Check if the source ContourLineKit is equivalent to this object.

Param in_kit: The source ContourLineKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

void Set (HPS.ContourLineKit in_kit)

Copies the source ContourLineKit into this object.

Param in_kit: The source object to copy.

HPS.ContourLineKit SetColors (HPS.RGBColor in_color)

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

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

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

void Show (out HPS.ContourLineKit out_kit)

Copies this object into the given ContourLineKit.

Param out_kit: The ContourLineKit to populate with the contents of 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.ContourLineKit UnsetColors ()

Removes the contour line colors setting.

Return: A reference to this object.

HPS.ContourLineKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.ContourLineKit UnsetLighting ()

Removes the contour line lighting setting.

Return: A reference to this object.

HPS.ContourLineKit UnsetPatterns ()

Removes the contour line patterns setting.

Return: A reference to this object.

HPS.ContourLineKit UnsetPositions ()

Removes the contour line positions setting.

Return: A reference to this object.

HPS.ContourLineKit UnsetVisibility ()

Removes the contour line visibility setting.

Return: A reference to this object.

HPS.ContourLineKit UnsetWeights ()

Removes the contour line weights setting.

Return: A reference to this object.

Public Static Functions

HPS.ContourLineKit GetDefault ()

Creates a ContourLineKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return: A ContourLineKit with the default settings.

bool operator!= (HPS.ContourLineKit a, HPS.ContourLineKit b)

bool operator== (HPS.ContourLineKit a, HPS.ContourLineKit b)