HPS.ContourLineControl Class Reference
Inheritance diagram for HPS.ContourLineControl:
HPS.Control HPS.Object

Public Member Functions

 ContourLineControl (HPS.SegmentKey in_seg)
 
 ContourLineControl (HPS.ContourLineControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.ContourLineControl SetColors (HPS.RGBColor[] in_colors)
 
HPS.ContourLineControl SetColors (HPS.RGBColor in_rgb_color)
 
HPS.ContourLineControl SetLighting (bool in_state)
 
HPS.ContourLineControl SetPatterns (string[] in_patterns)
 
HPS.ContourLineControl SetPatterns (string in_pattern)
 
HPS.ContourLineControl SetPositions (float in_interval, float in_offset)
 
HPS.ContourLineControl SetPositions (float[] in_positions)
 
HPS.ContourLineControl SetVisibility (bool in_state)
 
HPS.ContourLineControl SetWeights (float[] in_weights, HPS.Line.SizeUnits[] in_units)
 
HPS.ContourLineControl SetWeights (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.ContourLineControl SetWeights (float in_weight)
 
bool ShowColors (out HPS.RGBColor[] out_colors)
 
bool ShowLighting (out bool out_state)
 
bool ShowPatterns (out string[] out_patterns)
 
bool ShowPositions (out HPS.ContourLine.Mode out_mode, out float[] out_positions)
 
bool ShowVisibility (out bool out_state)
 
bool ShowWeights (out float[] out_weights, out HPS.Line.SizeUnits[] out_units)
 
override HPS.Type Type ()
 
HPS.ContourLineControl UnsetColors ()
 
HPS.ContourLineControl UnsetEverything ()
 
HPS.ContourLineControl UnsetLighting ()
 
HPS.ContourLineControl UnsetPatterns ()
 
HPS.ContourLineControl UnsetPositions ()
 
HPS.ContourLineControl UnsetVisibility ()
 
HPS.ContourLineControl UnsetWeights ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Control
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ContourLineControl() [1/2]

HPS.ContourLineControl.ContourLineControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ ContourLineControl() [2/2]

HPS.ContourLineControl.ContourLineControl ( HPS.ContourLineControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.ContourLineControl.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.

◆ SetColors() [1/2]

HPS.ContourLineControl HPS.ContourLineControl.SetColors ( HPS.RGBColor []  in_colors)
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_colorsAn array of colors to be used for drawing contour lines.
Returns
A reference to this object.

◆ SetColors() [2/2]

HPS.ContourLineControl HPS.ContourLineControl.SetColors ( HPS.RGBColor  in_rgb_color)
inline

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

Parameters
in_rgb_colorThe color to be used for drawing all contour lines
Returns
A reference to this object.

◆ SetLighting()

HPS.ContourLineControl HPS.ContourLineControl.SetLighting ( bool  in_state)
inline

Controls whether contour lines are lit.

Parameters
in_stateWhether contour lines are lit.
Returns
A reference to this object.

◆ SetPatterns() [1/2]

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

HPS.ContourLineControl HPS.ContourLineControl.SetPatterns ( string  in_pattern)
inline

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

Parameters
in_patternThe 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]

HPS.ContourLineControl HPS.ContourLineControl.SetPositions ( float  in_interval,
float  in_offset 
)
inline

Controls the positioning of contour lines. This variant creates them at regular intervals with an optional offset.

Parameters
in_intervalThe number of units between contour lines.
in_offsetThe starting point for contour lines.
Returns
A reference to this object.

◆ SetPositions() [2/2]

HPS.ContourLineControl HPS.ContourLineControl.SetPositions ( float []  in_positions)
inline

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

Parameters
in_positionsAn array of explicit locations to draw contour lines.
Returns
A reference to this object.

◆ SetVisibility()

HPS.ContourLineControl HPS.ContourLineControl.SetVisibility ( bool  in_state)
inline

Determines whether contour lines should be rendered.

Parameters
in_stateWhether contour lines should be rendered.
Returns
A reference to this object.

◆ SetWeights() [1/3]

HPS.ContourLineControl HPS.ContourLineControl.SetWeights ( float []  in_weights,
HPS.Line.SizeUnits []  in_units 
)
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_weightsAn array of line weights to be applied to contour lines.
in_unitsAn array of line weight units used with the corresponding entry in in_weights.
Returns
A reference to this object.

◆ SetWeights() [2/3]

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

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

Parameters
in_weightThe line weight to be used for drawing all contour lines.
in_unitsThe units associated with in_weight.
Returns
A reference to this object.

◆ SetWeights() [3/3]

HPS.ContourLineControl HPS.ContourLineControl.SetWeights ( float  in_weight)
inline

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

Parameters
in_weightThe line weight to be used for drawing all contour lines.
Returns
A reference to this object.

◆ ShowColors()

bool HPS.ContourLineControl.ShowColors ( out HPS.RGBColor []  out_colors)
inline

Shows the colors of contour lines.

Parameters
out_colorsAn array of colors of contour lines
Returns
true if the setting is valid, false otherwise.

◆ ShowLighting()

bool HPS.ContourLineControl.ShowLighting ( out bool  out_state)
inline

Shows whether contour lines should be lit.

Parameters
out_stateWhether contour lines should be lit.
Returns
true if the setting is valid, false otherwise.

◆ ShowPatterns()

bool HPS.ContourLineControl.ShowPatterns ( out string []  out_patterns)
inline

Shows the line patterns of contour lines.

Parameters
out_patternsAn array of line pattern names for contour lines.
Returns
true if the setting is valid, false otherwise.

◆ ShowPositions()

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

Shows the positions of contour lines.

Parameters
out_modeWhether the positions repeat at some interval or are an explicit list.
out_positionsIf 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.ContourLineControl.ShowVisibility ( out bool  out_state)
inline

Shows the visibility state of contour lines.

Parameters
out_stateWhether contour lines should be rendered.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeights()

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

Shows the line weights of contour lines.

Parameters
out_weightsAn array of line weights for contour lines.
out_unitsAn array of line weight units, each is applied to the corresponding entry in out_weights
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.ContourLineControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Object.

◆ UnsetColors()

HPS.ContourLineControl HPS.ContourLineControl.UnsetColors ( )
inline

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

Returns
A reference to this object.

◆ UnsetEverything()

HPS.ContourLineControl HPS.ContourLineControl.UnsetEverything ( )
inline

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

Returns
A reference to this object.

◆ UnsetLighting()

HPS.ContourLineControl HPS.ContourLineControl.UnsetLighting ( )
inline

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

Returns
A reference to this object.

◆ UnsetPatterns()

HPS.ContourLineControl HPS.ContourLineControl.UnsetPatterns ( )
inline

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

Returns
A reference to this object.

◆ UnsetPositions()

HPS.ContourLineControl HPS.ContourLineControl.UnsetPositions ( )
inline

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

Returns
A reference to this object.

◆ UnsetVisibility()

HPS.ContourLineControl HPS.ContourLineControl.UnsetVisibility ( )
inline

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

Returns
A reference to this object.

◆ UnsetWeights()

HPS.ContourLineControl HPS.ContourLineControl.UnsetWeights ( )
inline

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

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ContourLineControl.cs