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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HiddenLineAttributeKit in_kit)
 
override int GetHashCode ()
 
 HiddenLineAttributeKit ()
 
 HiddenLineAttributeKit (HPS.HiddenLineAttributeKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.HiddenLineAttributeKit in_kit)
 
HPS.HiddenLineAttributeKit SetAlgorithm (HPS.HiddenLine.Algorithm in_algorithm)
 
HPS.HiddenLineAttributeKit SetColor (HPS.RGBAColor in_color)
 
HPS.HiddenLineAttributeKit SetDimFactor (float in_zero_to_one)
 
HPS.HiddenLineAttributeKit SetFaceDisplacement (float in_buckets)
 
HPS.HiddenLineAttributeKit SetLinePattern (string in_pattern)
 
HPS.HiddenLineAttributeKit SetLineSorting (bool in_state, float in_threshold, HPS.Line.SizeUnits in_units)
 
HPS.HiddenLineAttributeKit SetLineSorting (bool in_state, float in_threshold)
 
HPS.HiddenLineAttributeKit SetLineSorting (bool in_state)
 
HPS.HiddenLineAttributeKit SetRenderFaces (bool in_state)
 
HPS.HiddenLineAttributeKit SetRenderText (bool in_state)
 
HPS.HiddenLineAttributeKit SetSilhouetteCleanup (bool in_state)
 
HPS.HiddenLineAttributeKit SetTransparencyCutoff (float in_zero_to_one)
 
HPS.HiddenLineAttributeKit SetVisibility (bool in_state)
 
HPS.HiddenLineAttributeKit SetWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.HiddenLineAttributeKit SetWeight (float in_weight)
 
void Show (out HPS.HiddenLineAttributeKit out_kit)
 
bool ShowAlgorithm (out HPS.HiddenLine.Algorithm out_algorithm)
 
bool ShowColor (out HPS.RGBAColor out_color)
 
bool ShowDimFactor (out float out_zero_to_one)
 
bool ShowFaceDisplacement (out float out_buckets)
 
bool ShowLinePattern (out string out_pattern)
 
bool ShowLineSorting (out bool out_state, out float out_threshold, out HPS.Line.SizeUnits out_units)
 
bool ShowRenderFaces (out bool out_state)
 
bool ShowRenderText (out bool out_state)
 
bool ShowSilhouetteCleanup (out bool out_state)
 
bool ShowTransparencyCutoff (out float out_zero_to_one)
 
bool ShowVisibility (out bool out_state)
 
bool ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units)
 
HPS.HiddenLineAttributeKit UnsetAlgorithm ()
 
HPS.HiddenLineAttributeKit UnsetColor ()
 
HPS.HiddenLineAttributeKit UnsetDimFactor ()
 
HPS.HiddenLineAttributeKit UnsetEverything ()
 
HPS.HiddenLineAttributeKit UnsetFaceDisplacement ()
 
HPS.HiddenLineAttributeKit UnsetLinePattern ()
 
HPS.HiddenLineAttributeKit UnsetLineSorting ()
 
HPS.HiddenLineAttributeKit UnsetRenderFaces ()
 
HPS.HiddenLineAttributeKit UnsetRenderText ()
 
HPS.HiddenLineAttributeKit UnsetSilhouetteCleanup ()
 
HPS.HiddenLineAttributeKit UnsetTransparencyCutoff ()
 
HPS.HiddenLineAttributeKit UnsetVisibility ()
 
HPS.HiddenLineAttributeKit UnsetWeight ()
 
- 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.HiddenLineAttributeKit GetDefault ()
 
static bool operator!= (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit b)
 
static bool operator== (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit 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.HiddenLineAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.HiddenLineAttributeKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ HiddenLineAttributeKit() [1/2]

HPS.HiddenLineAttributeKit.HiddenLineAttributeKit ( )
inline

Initializes an empty kit.

◆ HiddenLineAttributeKit() [2/2]

HPS.HiddenLineAttributeKit.HiddenLineAttributeKit ( HPS.HiddenLineAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.HiddenLineAttributeKit.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.HiddenLineAttributeKit.Equals ( HPS.HiddenLineAttributeKit  in_kit)
inline

Check if the source HiddenLineAttributeKit is equivalent to this object.

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

◆ GetDefault()

static HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.GetDefault ( )
inlinestatic

Creates a HiddenLineAttributeKit 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 HiddenLineAttributeKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.HiddenLineAttributeKit.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.HiddenLineAttributeKit.Set ( HPS.HiddenLineAttributeKit  in_kit)
inline

Copies the source HiddenLineAttributeKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetAlgorithm()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetAlgorithm ( HPS.HiddenLine.Algorithm  in_algorithm)
inline

Specifies the sorting algorithm that should be used to sort faces that have been made visible by the SetRenderFaces method. Default is ZBuffer.

Parameters
in_algorithmThe algorithm used to sort visible faces.
Returns
A reference to this object.

◆ SetColor()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetColor ( HPS.RGBAColor  in_color)
inline

Sets the color to be applied to the hidden lines and markers.

Parameters
in_colorThe color hidden line geometry should be drawn in.
Returns
A reference to this object.

◆ SetDimFactor()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetDimFactor ( float  in_zero_to_one)
inline

Specifies the fraction of the current line color's R, G, and B channels to use for the color of hidden lines and markers. By default, Visualize will automatically take a fraction of the RGB values to darken the hidden lines and markers.

Parameters
in_zero_to_oneA multiplier, between [0,1], applied to each channel of the hidden line color.
Returns
A reference to this object.

◆ SetFaceDisplacement()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetFaceDisplacement ( float  in_buckets)
inline

Specifies how many units to push faces away from the camera. This can help improve hidden line scene quality if distinct polylines/lines are being used to denote user-defined edges on shell/mesh regions, but are not exactly coincident with the actual shell/mesh edges. Note: hidden line face displacement is separate from the general face displacement value set with the DrawingAttributeKit.SetFaceDisplacement.

Parameters
in_bucketsThe number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.
Returns
A reference to this object.
See also
DrawingAttributeKit.SetFaceDisplacement()

◆ SetLinePattern()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetLinePattern ( string  in_pattern)
inline

Specifies the pattern of the hidden lines.

Parameters
in_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.

◆ SetLineSorting() [1/3]

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetLineSorting ( bool  in_state,
float  in_threshold,
HPS.Line.SizeUnits  in_units 
)
inline

Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be drawn in proper z-order. If this option is not activated, the order in which lines are drawn is non-deterministic. Enabling this option will result in slower performance. Due to the poor performance, this option is not recommended for screen drawing. However, it may be useful for hardcopy export. Use the functions HPS.Hardcopy.GDI.ExportOptionsKit.SetHiddenLineSorting() or HPS.Hardcopy.File.ExportOptionsKit.SetHiddenLineSorting() to enable this option for hardcopy export.

Parameters
in_stateShould hidden lines be sorted.
in_thresholdWhat is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted.
in_unitsWhat units in_threshold is specified in.
Returns
A reference to this object.

◆ SetLineSorting() [2/3]

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetLineSorting ( bool  in_state,
float  in_threshold 
)
inline

Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be drawn in proper z-order. If this option is not activated, the order in which lines are drawn is non-deterministic. Enabling this option will result in slower performance. Due to the poor performance, this option is not recommended for screen drawing. However, it may be useful for hardcopy export. Use the functions HPS.Hardcopy.GDI.ExportOptionsKit.SetHiddenLineSorting() or HPS.Hardcopy.File.ExportOptionsKit.SetHiddenLineSorting() to enable this option for hardcopy export.

Parameters
in_stateShould hidden lines be sorted.
in_thresholdWhat is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted.
Returns
A reference to this object.

◆ SetLineSorting() [3/3]

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetLineSorting ( bool  in_state)
inline

Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be drawn in proper z-order. If this option is not activated, the order in which lines are drawn is non-deterministic. Enabling this option will result in slower performance. Due to the poor performance, this option is not recommended for screen drawing. However, it may be useful for hardcopy export. Use the functions HPS.Hardcopy.GDI.ExportOptionsKit.SetHiddenLineSorting() or HPS.Hardcopy.File.ExportOptionsKit.SetHiddenLineSorting() to enable this option for hardcopy export.

Parameters
in_stateShould hidden lines be sorted.
Returns
A reference to this object.

◆ SetRenderFaces()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetRenderFaces ( bool  in_state)
inline

Specifies whether triangles will be displayed during a hidden-line rendering.

Parameters
in_stateWhether triangles will displayed during a hidden-line rendering.
Returns
A reference to this object.

◆ SetRenderText()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetRenderText ( bool  in_state)
inline

Specifies whether text will be displayed during a hidden-line rendering.

Parameters
in_stateWhether text will displayed during a hidden-line rendering.
Returns
A reference to this object.

◆ SetSilhouetteCleanup()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetSilhouetteCleanup ( bool  in_state)
inline

Silhouette edges can show unpleasant "fishtail" patterns at points on smooth surfaces where curvature in one orientation is very different from the curvature in another (e.g. the inside of a torus). Silhouette cleanup causes a post-process to remove most of these patterns.

Parameters
in_stateWhether hidden line rendering should be post-processed to remove visual artifacts.
Returns
A reference to this object.

◆ SetTransparencyCutoff()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetTransparencyCutoff ( float  in_zero_to_one)
inline

Specifies the threshold for when transparent objects are considered opaque. Objects with transparency greater than the cutoff will be considered opaque while objects with transparency less than the cutoff will treated as transparent.

Parameters
in_zero_to_oneThe cutoff value, between [0,1].
Returns
A reference to this object.

◆ SetVisibility()

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

Specifies whether hidden lines and markers should be displayed.

Parameters
in_stateThe algorithm to be used during hidden line rendering.
Returns
A reference to this object.

◆ SetWeight() [1/2]

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetWeight ( float  in_weight,
HPS.Line.SizeUnits  in_units 
)
inline

Sets the weight of lines drawn in hidden line rendering.

Parameters
in_weightThe weight value for hidden lines.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.

◆ SetWeight() [2/2]

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.SetWeight ( float  in_weight)
inline

Sets the weight of lines drawn in hidden line rendering.

Parameters
in_weightThe weight value for hidden lines.
Returns
A reference to this object.

◆ Show()

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

Copies this object into the given HiddenLineAttributeKit.

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

◆ ShowAlgorithm()

bool HPS.HiddenLineAttributeKit.ShowAlgorithm ( out HPS.HiddenLine.Algorithm  out_algorithm)
inline

Shows the sorting algorithm that will be used to sort faces that have been made visible by the SetRenderFaces method.

Parameters
out_algorithmThe algorithm used to sort visible faces.
Returns
true if the setting is valid, false otherwise.

◆ ShowColor()

bool HPS.HiddenLineAttributeKit.ShowColor ( out HPS.RGBAColor  out_color)
inline

Shows the color applied to hidden lines and markers.

Parameters
out_colorThe color of hidden line geometry.
Returns
true if the setting is valid, false otherwise.

◆ ShowDimFactor()

bool HPS.HiddenLineAttributeKit.ShowDimFactor ( out float  out_zero_to_one)
inline

Shows the dim factor multiplier applied to each channel of the hidden line color.

Parameters
out_zero_to_oneA multiplier, between [0,1], applied to each channel of the hidden line color.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaceDisplacement()

bool HPS.HiddenLineAttributeKit.ShowFaceDisplacement ( out float  out_buckets)
inline

Shows the number of units to push faces away from the camera.

Parameters
out_bucketsThe number of "z buckets" to push faces away from the camera.
Returns
true if the setting is valid, false otherwise.

◆ ShowLinePattern()

bool HPS.HiddenLineAttributeKit.ShowLinePattern ( out string  out_pattern)
inline

Shows the pattern of the hidden lines.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
true if the setting is valid, false otherwise.

◆ ShowLineSorting()

bool HPS.HiddenLineAttributeKit.ShowLineSorting ( out bool  out_state,
out float  out_threshold,
out HPS.Line.SizeUnits  out_units 
)
inline

Shows the hidden line sorting options.

Parameters
out_stateWhether hidden line sorting is on or off.
out_thresholdThe minimum width at which hidden lines are sorted.
out_unitsThe units that out_threshold is measured in.
Returns
true if the setting is valid, false otherwise.

◆ ShowRenderFaces()

bool HPS.HiddenLineAttributeKit.ShowRenderFaces ( out bool  out_state)
inline

Shows whether triangles will be displayed during a hidden-line rendering.

Parameters
out_stateWhether triangles will displayed during a hidden-line rendering.
Returns
true if the setting is valid, false otherwise.

◆ ShowRenderText()

bool HPS.HiddenLineAttributeKit.ShowRenderText ( out bool  out_state)
inline

Shows whether text will be displayed during a hidden-line rendering.

Parameters
out_stateWhether text will displayed during a hidden-line rendering.
Returns
true if the setting is valid, false otherwise.

◆ ShowSilhouetteCleanup()

bool HPS.HiddenLineAttributeKit.ShowSilhouetteCleanup ( out bool  out_state)
inline

Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges.

Parameters
out_stateWhether hidden line rendering should be post-processed to remove visual artifacts.
Returns
true if the setting is valid, false otherwise.

◆ ShowTransparencyCutoff()

bool HPS.HiddenLineAttributeKit.ShowTransparencyCutoff ( out float  out_zero_to_one)
inline

Shows the threshold for when transparent objects are considered opaque.

Parameters
out_zero_to_oneThe cutoff value, between [0,1].
Returns
true if the setting is valid, false otherwise.

◆ ShowVisibility()

bool HPS.HiddenLineAttributeKit.ShowVisibility ( out bool  out_state)
inline

Shows whether hidden lines and markers should be displayed.

Parameters
out_stateWhether hidden lines and markers should be displayed.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS.HiddenLineAttributeKit.ShowWeight ( out float  out_weight,
out HPS.Line.SizeUnits  out_units 
)
inline

Shows the weight of lines drawn in hidden line rendering.

Parameters
out_weightThe weight value for hidden lines.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ UnsetAlgorithm()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetAlgorithm ( )
inline

Removes the hidden line algorithm setting.

Returns
A reference to this object.

◆ UnsetColor()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetColor ( )
inline

Removes the hidden line color setting.

Returns
A reference to this object.

◆ UnsetDimFactor()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetDimFactor ( )
inline

Removes the dim factor setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetFaceDisplacement()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetFaceDisplacement ( )
inline

Removes the face displacement setting.

Returns
A reference to this object.

◆ UnsetLinePattern()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetLinePattern ( )
inline

Removes the line pattern setting for hidden lines.

Returns
A reference to this object.

◆ UnsetLineSorting()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetLineSorting ( )
inline

Removes the line sorting setting.

Returns
A reference to this object.

◆ UnsetRenderFaces()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetRenderFaces ( )
inline

Removes the face rendering setting.

Returns
A reference to this object.

◆ UnsetRenderText()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetRenderText ( )
inline

Removes the text rendering setting.

Returns
A reference to this object.

◆ UnsetSilhouetteCleanup()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetSilhouetteCleanup ( )
inline

Removes the silhouette cleanup setting.

Returns
A reference to this object.

◆ UnsetTransparencyCutoff()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetTransparencyCutoff ( )
inline

Removes the transparency cutoff setting.

Returns
A reference to this object.

◆ UnsetVisibility()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetVisibility ( )
inline

Removes the hidden line visibility setting.

Returns
A reference to this object.

◆ UnsetWeight()

HPS.HiddenLineAttributeKit HPS.HiddenLineAttributeKit.UnsetWeight ( )
inline

Removes the weight setting for hidden line.

Returns
A reference to this object.

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