HiddenLineAttributeControl

class HPS.HiddenLineAttributeControl : public HPS.Control 

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.

Public Functions

override void Dispose ()

HiddenLineAttributeControl (HPS.HiddenLineAttributeControl in_that): Initializes a control tied to the same object as in_that.

HiddenLineAttributeControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

HPS.HiddenLineAttributeControl SetAlgorithm (HPS.HiddenLine.Algorithm in_algorithm)

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

Param in_algorithm: The algorithm used to sort visible faces.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetColor (HPS.RGBAColor in_color)

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

Param in_color: The color hidden line geometry should be drawn in.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetDimFactor (float in_zero_to_one)

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.

Param in_zero_to_one: A multiplier, between [0,1], applied to each channel of the hidden line color.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetFaceDisplacement (float in_buckets)

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.

See: DrawingAttributeKit.SetFaceDisplacement()

Param in_buckets: The 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.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetLinePattern (string in_pattern)

Specifies the pattern of the hidden lines.

Param in_pattern: The name of a line pattern, defined in a portfolio that is accessible.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetLineSorting (bool in_on)

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.

Param in_on: Whether to sort or not.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetLineSorting (bool in_on, float in_activation_weight)

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.

Param in_on: Whether to sort or not.
Param in_activation_weight: Lines thicker than this will be sorted. Thinner ones will be ignored.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetLineSorting (bool in_on, float in_activation_weight, HPS.Line.SizeUnits in_units)

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.

Param in_on: Whether to sort or not.
Param in_activation_weight: Lines thicker than this will be sorted. Thinner ones will be ignored.
Param in_units: Units applied to in_activation_weight.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetRenderFaces (bool in_state)

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

Param in_state: Whether triangles will displayed during a hidden-line rendering.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetRenderText (bool in_state)

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

Param in_state: Whether text will displayed during a hidden-line rendering.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetSilhouetteCleanup (bool in_state)

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.

Param in_state: Whether hidden line rendering should be post-processed to remove visual artifacts.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetTransparencyCutoff (float in_zero_to_one)

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.

Param in_zero_to_one: The cutoff value, between [0,1].
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetVisibility (bool in_state)

Specifies whether hidden lines and markers should be displayed.

Param in_state: The algorithm to be used during hidden line rendering.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetWeight (float in_weight)

Sets the weight of lines drawn in hidden line rendering.

Param in_weight: The weight value for hidden lines.
Return: A reference to this object.

HPS.HiddenLineAttributeControl SetWeight (float in_weight, HPS.Line.SizeUnits in_units)

Sets the weight of lines drawn in hidden line rendering.

Param in_weight: The weight value for hidden lines.
Param in_units: The units applied to in_weight.
Return: A reference to this object.

bool ShowAlgorithm (out HPS.HiddenLine.Algorithm out_algorithm)

Shows the algorithm to be used during hidden line rendering.

Param out_algorithm: The algorithm used for hidden line rendering.
Return: true if the setting is valid, false otherwise.

bool ShowColor (out HPS.RGBAColor out_color)

Shows the color applied to hidden lines and markers.

Param out_color: The color of hidden line geometry.
Return: true if the setting is valid, false otherwise.

bool ShowDimFactor (out float out_zero_to_one)

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

Param out_zero_to_one: A multiplier, between [0,1], applied to each channel of the hidden line color.
Return: true if the setting is valid, false otherwise.

bool ShowFaceDisplacement (out float out_buckets)

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

Param out_buckets: The number of “z buckets” to push faces away from the camera.
Return: true if the setting is valid, false otherwise.

bool ShowLinePattern (out string out_pattern)

Shows the pattern of the hidden lines.

Param out_pattern: The name of a line pattern, defined in a portfolio that is accessible.
Return: true if the setting is valid, false otherwise.

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

Shows the hidden line sorting options.

Param out_state: Whether hidden line sorting is on or off.
Param out_threshold: The minimum width at which hidden lines are sorted.
Param out_units: The units that out_threshold is measured in.
Return: true if the setting is valid, false otherwise.

bool ShowRenderFaces (out bool out_state)

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

Param out_state: Whether triangles will displayed during a hidden-line rendering.
Return: true if the setting is valid, false otherwise.

bool ShowRenderText (out bool out_state)

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

Param out_state: Whether text will displayed during a hidden-line rendering.
Return: true if the setting is valid, false otherwise.

bool ShowSilhouetteCleanup (out bool out_state)

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

Param out_state: Whether hidden line rendering should be post-processed to remove visual artifacts.
Return: true if the setting is valid, false otherwise.

bool ShowTransparencyCutoff (out float out_zero_to_one)

Shows the threshold for when transparent objects are considered opaque.

Param out_zero_to_one: The cutoff value, between [0,1].
Return: true if the setting is valid, false otherwise.

bool ShowVisibility (out bool out_state)

Shows whether hidden lines and markers should be displayed.

Param out_state: Whether hidden lines and markers should be displayed.
Return: true if the setting is valid, false otherwise.

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

Shows the weight of lines drawn in hidden line rendering.

Param out_weight: The weight value for hidden lines.
Param out_units: The units applied to in_weight.
Return: true if the setting is valid, false otherwise.

HPS.HiddenLineAttributeControl UnsetAlgorithm ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetColor ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetDimFactor ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetEverything ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetFaceDisplacement ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetLinePattern ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetLineSorting ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetRenderFaces ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetRenderText ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetSilhouetteCleanup ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetTransparencyCutoff ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetVisibility ()

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

Return: A reference to this object.

HPS.HiddenLineAttributeControl UnsetWeight ()

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

Return: A reference to this object.