Inheritance diagram for HPS.ContourLineKit:
HPS.Kit HPS.Object

Public Member Functions

 ContourLineKit ()
 
 ContourLineKit (HPS.ContourLineKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ContourLineKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ContourLineKit in_kit)
 
HPS.ContourLineKit SetColors (HPS.RGBColor[] in_colors)
 
HPS.ContourLineKit SetColors (HPS.RGBColor in_color)
 
HPS.ContourLineKit SetLighting (bool in_state)
 
HPS.ContourLineKit SetPatterns (string[] in_patterns)
 
HPS.ContourLineKit SetPatterns (string in_pattern)
 
HPS.ContourLineKit SetPositions (float in_interval, float in_offset)
 
HPS.ContourLineKit SetPositions (float[] in_positions)
 
HPS.ContourLineKit SetVisibility (bool in_state)
 
HPS.ContourLineKit SetWeights (float[] in_weights, HPS.Line.SizeUnits[] in_units)
 
HPS.ContourLineKit SetWeights (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.ContourLineKit SetWeights (float in_weight)
 
void Show (out HPS.ContourLineKit out_kit)
 
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)
 
HPS.ContourLineKit UnsetColors ()
 
HPS.ContourLineKit UnsetEverything ()
 
HPS.ContourLineKit UnsetLighting ()
 
HPS.ContourLineKit UnsetPatterns ()
 
HPS.ContourLineKit UnsetPositions ()
 
HPS.ContourLineKit UnsetVisibility ()
 
HPS.ContourLineKit UnsetWeights ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.ContourLineKit GetDefault ()
 
static bool operator!= (HPS.ContourLineKit a, HPS.ContourLineKit b)
 
static bool operator== (HPS.ContourLineKit a, HPS.ContourLineKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ ContourLineKit() [1/2]

HPS.ContourLineKit.ContourLineKit ( )
inline

Initializes an empty kit.

◆ ContourLineKit() [2/2]

HPS.ContourLineKit.ContourLineKit ( HPS.ContourLineKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

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

bool HPS.ContourLineKit.Equals ( HPS.ContourLineKit  in_kit)
inline

Check if the source ContourLineKit is equivalent to this object.

Parameters
in_kitThe source ContourLineKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.ContourLineKit HPS.ContourLineKit.GetDefault ( )
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.

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

void HPS.ContourLineKit.Set ( HPS.ContourLineKit  in_kit)
inline

Copies the source ContourLineKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetColors() [1/2]

HPS.ContourLineKit HPS.ContourLineKit.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.ContourLineKit HPS.ContourLineKit.SetColors ( HPS.RGBColor  in_color)
inline

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

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

◆ SetLighting()

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

◆ Show()

void HPS.ContourLineKit.Show ( out HPS.ContourLineKit  out_kit)
inline

Copies this object into the given ContourLineKit.

Parameters
out_kitThe ContourLineKit to populate with the contents of this object.

◆ ShowColors()

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

◆ UnsetColors()

HPS.ContourLineKit HPS.ContourLineKit.UnsetColors ( )
inline

Removes the contour line colors setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.ContourLineKit HPS.ContourLineKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetLighting()

HPS.ContourLineKit HPS.ContourLineKit.UnsetLighting ( )
inline

Removes the contour line lighting setting.

Returns
A reference to this object.

◆ UnsetPatterns()

HPS.ContourLineKit HPS.ContourLineKit.UnsetPatterns ( )
inline

Removes the contour line patterns setting.

Returns
A reference to this object.

◆ UnsetPositions()

HPS.ContourLineKit HPS.ContourLineKit.UnsetPositions ( )
inline

Removes the contour line positions setting.

Returns
A reference to this object.

◆ UnsetVisibility()

HPS.ContourLineKit HPS.ContourLineKit.UnsetVisibility ( )
inline

Removes the contour line visibility setting.

Returns
A reference to this object.

◆ UnsetWeights()

HPS.ContourLineKit HPS.ContourLineKit.UnsetWeights ( )
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