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

Public Member Functions

override void Dispose ()
 
 HiddenLineAttributeControl (HPS.SegmentKey in_seg)
 
 HiddenLineAttributeControl (HPS.HiddenLineAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.HiddenLineAttributeControl SetAlgorithm (HPS.HiddenLine.Algorithm in_algorithm)
 
HPS.HiddenLineAttributeControl SetColor (HPS.RGBAColor in_color)
 
HPS.HiddenLineAttributeControl SetDimFactor (float in_zero_to_one)
 
HPS.HiddenLineAttributeControl SetFaceDisplacement (float in_buckets)
 
HPS.HiddenLineAttributeControl SetLinePattern (string in_pattern)
 
HPS.HiddenLineAttributeControl SetLineSorting (bool in_on, float in_activation_weight, HPS.Line.SizeUnits in_units)
 
HPS.HiddenLineAttributeControl SetLineSorting (bool in_on, float in_activation_weight)
 
HPS.HiddenLineAttributeControl SetLineSorting (bool in_on)
 
HPS.HiddenLineAttributeControl SetRenderFaces (bool in_state)
 
HPS.HiddenLineAttributeControl SetRenderText (bool in_state)
 
HPS.HiddenLineAttributeControl SetSilhouetteCleanup (bool in_state)
 
HPS.HiddenLineAttributeControl SetTransparencyCutoff (float in_zero_to_one)
 
HPS.HiddenLineAttributeControl SetVisibility (bool in_state)
 
HPS.HiddenLineAttributeControl SetWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.HiddenLineAttributeControl SetWeight (float in_weight)
 
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)
 
override HPS.Type Type ()
 
HPS.HiddenLineAttributeControl UnsetAlgorithm ()
 
HPS.HiddenLineAttributeControl UnsetColor ()
 
HPS.HiddenLineAttributeControl UnsetDimFactor ()
 
HPS.HiddenLineAttributeControl UnsetEverything ()
 
HPS.HiddenLineAttributeControl UnsetFaceDisplacement ()
 
HPS.HiddenLineAttributeControl UnsetLinePattern ()
 
HPS.HiddenLineAttributeControl UnsetLineSorting ()
 
HPS.HiddenLineAttributeControl UnsetRenderFaces ()
 
HPS.HiddenLineAttributeControl UnsetRenderText ()
 
HPS.HiddenLineAttributeControl UnsetSilhouetteCleanup ()
 
HPS.HiddenLineAttributeControl UnsetTransparencyCutoff ()
 
HPS.HiddenLineAttributeControl UnsetVisibility ()
 
HPS.HiddenLineAttributeControl UnsetWeight ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- 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.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.HiddenLineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the various attributes associated with hidden lines. Hidden line is a rendering mode that applies to the scene as a whole. You should not set disparate hidden line attributes in your scene.

This table lists default values for the various segment attributes accessible from HPS.HiddenLineAttributeControl.

Constructor & Destructor Documentation

◆ HiddenLineAttributeControl() [1/2]

HPS.HiddenLineAttributeControl.HiddenLineAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ HiddenLineAttributeControl() [2/2]

HPS.HiddenLineAttributeControl.HiddenLineAttributeControl ( HPS.HiddenLineAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

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

◆ SetAlgorithm()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetLineSorting ( bool  in_on,
float  in_activation_weight,
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 draw 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_onWhether to sort or not.
in_activation_weightLines thicker than this will be sorted. Thinner ones will be ignored.
in_unitsUnits applied to in_activation_weight.
Returns
A reference to this object.

◆ SetLineSorting() [2/3]

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetLineSorting ( bool  in_on,
float  in_activation_weight 
)
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 draw 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_onWhether to sort or not.
in_activation_weightLines thicker than this will be sorted. Thinner ones will be ignored.
Returns
A reference to this object.

◆ SetLineSorting() [3/3]

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetLineSorting ( bool  in_on)
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 draw 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_onWhether to sort or not.
Returns
A reference to this object.

◆ SetRenderFaces()

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

◆ ShowAlgorithm()

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

Shows the algorithm to be used during hidden line rendering.

Parameters
out_algorithmThe algorithm used for hidden line rendering.
Returns
true if the setting is valid, false otherwise.

◆ ShowColor()

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

◆ Type()

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

◆ UnsetAlgorithm()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetAlgorithm ( )
inline

Removes the hidden line algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetColor()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetColor ( )
inline

Removes the hidden line color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetDimFactor()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetDimFactor ( )
inline

Removes the dim factor setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.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 HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetFaceDisplacement()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetFaceDisplacement ( )
inline

Removes the face displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetLinePattern()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetLinePattern ( )
inline

Removes the line pattern setting for hidden lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetLineSorting()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetLineSorting ( )
inline

Removes the line sorting settings for hidden lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetRenderFaces()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetRenderFaces ( )
inline

Removes the face rendering setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetRenderText()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetRenderText ( )
inline

Removes the text rendering setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetSilhouetteCleanup()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetSilhouetteCleanup ( )
inline

Removes the silhouette cleanup setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetTransparencyCutoff()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetTransparencyCutoff ( )
inline

Removes the transparency cutoff setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetVisibility()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetVisibility ( )
inline

Removes the hidden line visibility setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetWeight()

HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetWeight ( )
inline

Removes the weight setting for hidden line. If the control is attached to a WindowKey this function restores the default value of this setting as specified by HiddenLineAttributeKit.GetDefault().

Returns
A reference to this object.

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