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

Public Member Functions | |
ContourLineKit () | |
Initializes an empty kit. More... | |
ContourLineKit (HPS.ContourLineKit in_kit) | |
The copy constructor creates a new ContourLineKit object that contains the same settings as the source object. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ContourLineKit in_kit) |
Check if the source ContourLineKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.ContourLineKit in_kit) |
Copies the source ContourLineKit into this object. More... | |
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. More... | |
HPS.ContourLineKit | SetColors (HPS.RGBColor in_color) |
Sets the color to be used for drawing all contour lines. More... | |
HPS.ContourLineKit | SetLighting (bool in_state) |
Controls whether contour lines are lit. More... | |
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. More... | |
HPS.ContourLineKit | SetPatterns (string in_pattern) |
Sets the line pattern to be used for drawing all contour lines. More... | |
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. More... | |
HPS.ContourLineKit | SetPositions (float[] in_positions) |
Controls the positioning of contour lines. This variant defines explicit locations that contour lines should appear at. More... | |
HPS.ContourLineKit | SetVisibility (bool in_state) |
Determines whether contour lines should be rendered. More... | |
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. More... | |
HPS.ContourLineKit | SetWeights (float in_weight, HPS.Line.SizeUnits in_units) |
Sets the line weight to be used for drawing all contour lines. More... | |
HPS.ContourLineKit | SetWeights (float in_weight) |
Sets the line weight to be used for drawing all contour lines. More... | |
void | Show (out HPS.ContourLineKit out_kit) |
Copies this object into the given ContourLineKit. 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.ContourLineKit | UnsetColors () |
Removes the contour line colors setting. More... | |
HPS.ContourLineKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.ContourLineKit | UnsetLighting () |
Removes the contour line lighting setting. More... | |
HPS.ContourLineKit | UnsetPatterns () |
Removes the contour line patterns setting. More... | |
HPS.ContourLineKit | UnsetPositions () |
Removes the contour line positions setting. More... | |
HPS.ContourLineKit | UnsetVisibility () |
Removes the contour line visibility setting. More... | |
HPS.ContourLineKit | UnsetWeights () |
Removes the contour line weights setting. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.ContourLineKit a, HPS.ContourLineKit b) |
static bool | operator== (HPS.ContourLineKit a, HPS.ContourLineKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new ContourLineKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ContourLineKit is equivalent to this object.
- Parameters
-
in_kit The source ContourLineKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- A ContourLineKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Copies the source ContourLineKit into this object.
- Parameters
-
in_kit The source object to copy.
|
inline |
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.
|
inline |
Sets the color to be used for drawing all contour lines.
- Parameters
-
in_color The color to be used for drawing all contour lines
- Returns
- A reference to this object.
|
inline |
Controls whether contour lines are lit.
- Parameters
-
in_state Whether contour lines are lit.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Determines whether contour lines should be rendered.
- Parameters
-
in_state Whether contour lines should be rendered.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
- Returns
- A reference to this object.
|
inline |
Copies this object into the given ContourLineKit.
- Parameters
-
out_kit The ContourLineKit to populate with the contents of this object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Removes the contour line colors setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the contour line lighting setting.
- Returns
- A reference to this object.
|
inline |
Removes the contour line patterns setting.
- Returns
- A reference to this object.
|
inline |
Removes the contour line positions setting.
- Returns
- A reference to this object.
|
inline |
Removes the contour line visibility setting.
- Returns
- A reference to this object.
|
inline |
Removes the contour line weights setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ContourLineKit.cs