REFERENCE MANUAL
The ContourLineControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
ContourLineControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
ContourLineControl (HPS.ContourLineControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.ContourLineControl | SetColors (HPS.RGBColor[] in_rgb_colors) |
Sets the colors to be used for drawing contour lines. More... | |
HPS.ContourLineControl | SetColors (HPS.RGBColor in_rgb_color) |
Sets the color to be used for drawing all contour lines. More... | |
HPS.ContourLineControl | SetLighting (bool in_state) |
Controls whether contour lines are lit. More... | |
HPS.ContourLineControl | SetPatterns (string[] in_patterns) |
Sets the line patterns to be used for drawing contour lines. More... | |
HPS.ContourLineControl | SetPatterns (string in_pattern) |
Sets the line pattern to be used for drawing all contour lines. More... | |
HPS.ContourLineControl | SetPositions (float in_interval, float in_offset) |
Controls the positioning of contour lines. More... | |
HPS.ContourLineControl | SetPositions (float[] in_positions) |
Controls the positioning of contour lines. More... | |
HPS.ContourLineControl | SetVisibility (bool in_state) |
Determines whether contour lines should be rendered. More... | |
HPS.ContourLineControl | SetWeights (float[] in_weights, HPS.Line.SizeUnits[] in_units) |
Sets the line weights to be used for drawing contour lines. More... | |
HPS.ContourLineControl | SetWeights (float in_weight, HPS.Line.SizeUnits in_units) |
Sets the line weight to be used for drawing all contour lines. More... | |
HPS.ContourLineControl | SetWeights (float in_weight) |
Sets the line weight to be used for drawing all contour lines. More... | |
bool | ShowColors (out HPS.RGBColor[] out_colors) |
Shows the colors of contour lines. More... | |
bool | ShowLighting (out bool out_state) |
Shows whether contour lines should be lit. More... | |
bool | ShowPatterns (out string[] out_patterns) |
Shows the line patterns of contour lines. More... | |
bool | ShowPositions (out HPS.ContourLine.Mode out_mode, out float[] out_positions) |
Shows the positions of contour lines. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility state of contour lines. More... | |
bool | ShowWeights (out float[] out_weights, out HPS.Line.SizeUnits[] out_units) |
Shows the line weights of contour lines. More... | |
HPS.ContourLineControl | UnsetColors () |
Removes the contour line colors setting. More... | |
HPS.ContourLineControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.ContourLineControl | UnsetLighting () |
Removes the contour line lighting setting. More... | |
HPS.ContourLineControl | UnsetPatterns () |
Removes the contour line patterns setting. More... | |
HPS.ContourLineControl | UnsetPositions () |
Removes the contour line positions setting. More... | |
HPS.ContourLineControl | UnsetVisibility () |
Removes the contour line visibility setting. More... | |
HPS.ContourLineControl | UnsetWeights () |
Removes the contour line weights setting. More... | |
![]() | |
Control (HPS.Control in_that) | |
override void | Dispose () |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 ContourLineControl.
HPS.ContourLineControl.ContourLineControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.ContourLineControl.ContourLineControl | ( | HPS.ContourLineControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.ContourLineControl HPS.ContourLineControl.SetColors | ( | HPS.RGBColor[] | in_rgb_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.
in_count | The number of elements in in_colors. |
HPS.ContourLineControl HPS.ContourLineControl.SetColors | ( | HPS.RGBColor | in_rgb_color | ) |
Sets the color to be used for drawing all contour lines.
HPS.ContourLineControl HPS.ContourLineControl.SetLighting | ( | bool | in_state | ) |
Controls whether contour lines are lit.
in_state | Whether contour lines are lit. |
HPS.ContourLineControl 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.
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. |
HPS.ContourLineControl HPS.ContourLineControl.SetPatterns | ( | string | in_pattern | ) |
Sets the line pattern to be used for drawing all contour lines.
HPS.ContourLineControl 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.
in_interval | The number of units between contour lines. |
in_offset | The starting point for contour lines. |
HPS.ContourLineControl HPS.ContourLineControl.SetPositions | ( | float[] | in_positions | ) |
Controls the positioning of contour lines.
This variant defines explicit locations that contour lines should appear at.
in_count | The number of elements in in_positions. |
in_positions | An array of explicit locations to draw contour lines. |
HPS.ContourLineControl HPS.ContourLineControl.SetVisibility | ( | bool | in_state | ) |
Determines whether contour lines should be rendered.
in_state | Whether contour lines should be rendered. |
HPS.ContourLineControl 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.
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. |
HPS.ContourLineControl HPS.ContourLineControl.SetWeights | ( | float | in_weight, |
HPS.Line.SizeUnits | in_units | ||
) |
Sets the line weight to be used for drawing all contour lines.
in_weight | The line weight to be used for drawing all contour lines. |
in_units | The units associated with in_weight. |
HPS.ContourLineControl HPS.ContourLineControl.SetWeights | ( | float | in_weight | ) |
Sets the line weight to be used for drawing all contour lines.
in_weight | The line weight to be used for drawing all contour lines. |
bool HPS.ContourLineControl.ShowColors | ( | out HPS.RGBColor[] | out_colors | ) |
Shows the colors of contour lines.
out_colors | An array of colors of contour lines |
bool HPS.ContourLineControl.ShowLighting | ( | out bool | out_state | ) |
Shows whether contour lines should be lit.
out_state | Whether contour lines should be lit. |
bool HPS.ContourLineControl.ShowPatterns | ( | out string[] | out_patterns | ) |
Shows the line patterns of contour lines.
out_patterns | An array of line pattern names for contour lines. |
bool HPS.ContourLineControl.ShowPositions | ( | out HPS.ContourLine.Mode | out_mode, |
out float[] | out_positions | ||
) |
Shows the positions of contour lines.
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. |
bool HPS.ContourLineControl.ShowVisibility | ( | out bool | out_state | ) |
Shows the visibility state of contour lines.
out_state | Whether contour lines should be rendered. |
bool HPS.ContourLineControl.ShowWeights | ( | out float[] | out_weights, |
out HPS.Line.SizeUnits[] | out_units | ||
) |
Shows the line weights of contour lines.
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 |
HPS.ContourLineControl HPS.ContourLineControl.UnsetColors | ( | ) |
Removes the contour line colors setting.
HPS.ContourLineControl HPS.ContourLineControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.ContourLineControl HPS.ContourLineControl.UnsetLighting | ( | ) |
Removes the contour line lighting setting.
HPS.ContourLineControl HPS.ContourLineControl.UnsetPatterns | ( | ) |
Removes the contour line patterns setting.
HPS.ContourLineControl HPS.ContourLineControl.UnsetPositions | ( | ) |
Removes the contour line positions setting.
HPS.ContourLineControl HPS.ContourLineControl.UnsetVisibility | ( | ) |
Removes the contour line visibility setting.
HPS.ContourLineControl HPS.ContourLineControl.UnsetWeights | ( | ) |
Removes the contour line weights setting.