|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ContourLineKit() [1/2]
HPS.ContourLineKit.ContourLineKit |
( |
| ) |
|
|
inline |
Initializes an empty kit.
◆ ContourLineKit() [2/2]
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. |
◆ Empty()
override bool HPS.ContourLineKit.Empty |
( |
| ) |
|
|
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.
◆ Equals()
Check if the source ContourLineKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A ContourLineKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.ContourLineKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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.
Reimplemented from HPS.Object.
◆ Set()
Copies the source ContourLineKit into this object.
- Parameters
-
in_kit | The source object to copy. |
◆ SetColors() [1/2]
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.
◆ SetColors() [2/2]
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.
◆ SetLighting()
Controls whether contour lines are lit.
- Parameters
-
in_state | Whether contour lines are lit. |
- Returns
- A reference to this object.
◆ SetPatterns() [1/2]
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.
◆ SetPatterns() [2/2]
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.
◆ SetPositions() [1/2]
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.
◆ SetPositions() [2/2]
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.
◆ SetVisibility()
Determines whether contour lines should be rendered.
- Parameters
-
in_state | Whether contour lines should be rendered. |
- Returns
- A reference to this object.
◆ SetWeights() [1/3]
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.
◆ SetWeights() [2/3]
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.
◆ SetWeights() [3/3]
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.
◆ Show()
◆ ShowColors()
bool HPS.ContourLineKit.ShowColors |
( |
out HPS.RGBColor [] |
out_colors | ) |
|
|
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.
◆ ShowLighting()
bool HPS.ContourLineKit.ShowLighting |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowPatterns()
bool HPS.ContourLineKit.ShowPatterns |
( |
out string [] |
out_patterns | ) |
|
|
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.
◆ ShowPositions()
bool HPS.ContourLineKit.ShowPositions |
( |
out HPS.ContourLine.Mode |
out_mode, |
|
|
out float [] |
out_positions |
|
) |
| |
|
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.
◆ ShowVisibility()
bool HPS.ContourLineKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowWeights()
bool HPS.ContourLineKit.ShowWeights |
( |
out float [] |
out_weights, |
|
|
out HPS.Line.SizeUnits [] |
out_units |
|
) |
| |
|
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.
◆ UnsetColors()
Removes the contour line colors setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetLighting()
Removes the contour line lighting setting.
- Returns
- A reference to this object.
◆ UnsetPatterns()
Removes the contour line patterns setting.
- Returns
- A reference to this object.
◆ UnsetPositions()
Removes the contour line positions setting.
- Returns
- A reference to this object.
◆ UnsetVisibility()
Removes the contour line visibility setting.
- Returns
- A reference to this object.
◆ UnsetWeights()
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