HiddenLineAttributeKit

class HPS.HiddenLineAttributeKit : public HPS.Kit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return: true if no values are set on this object, false otherwise.

bool Equals (HPS.HiddenLineAttributeKit in_kit)

Check if the source HiddenLineAttributeKit is equivalent to this object.

Param in_kit: The source HiddenLineAttributeKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HiddenLineAttributeKit (): Initializes an empty kit.

HiddenLineAttributeKit (HPS.HiddenLineAttributeKit in_kit)

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

Param in_kit: The source object to copy.

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.

void Set (HPS.HiddenLineAttributeKit in_kit)

Copies the source HiddenLineAttributeKit into this object.

Param in_kit: The source object to copy.

HPS.HiddenLineAttributeKit 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.HiddenLineAttributeKit 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.HiddenLineAttributeKit 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.HiddenLineAttributeKit 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.HiddenLineAttributeKit 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.HiddenLineAttributeKit SetLineSorting (bool in_state)

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.

Param in_state: Should hidden lines be sorted.
Return: A reference to this object.

HPS.HiddenLineAttributeKit SetLineSorting (bool in_state, float in_threshold)

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.

Param in_state: Should hidden lines be sorted.
Param in_threshold: What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted.
Return: A reference to this object.

HPS.HiddenLineAttributeKit SetLineSorting (bool in_state, float in_threshold, 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 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.

Param in_state: Should hidden lines be sorted.
Param in_threshold: What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted.
Param in_units: What units in_threshold is specified in.
Return: A reference to this object.

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

void Show (out HPS.HiddenLineAttributeKit out_kit)

Copies this object into the given HiddenLineAttributeKit.

Param out_kit: The HiddenLineAttributeKit to populate with the contents of this object.

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

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

Param out_algorithm: The algorithm used to sort visible faces.
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.HiddenLineAttributeKit UnsetAlgorithm ()

Removes the hidden line algorithm setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetColor ()

Removes the hidden line color setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetDimFactor ()

Removes the dim factor setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetFaceDisplacement ()

Removes the face displacement setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetLinePattern ()

Removes the line pattern setting for hidden lines.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetLineSorting ()

Removes the line sorting setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetRenderFaces ()

Removes the face rendering setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetRenderText ()

Removes the text rendering setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetSilhouetteCleanup ()

Removes the silhouette cleanup setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetTransparencyCutoff ()

Removes the transparency cutoff setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetVisibility ()

Removes the hidden line visibility setting.

Return: A reference to this object.

HPS.HiddenLineAttributeKit UnsetWeight ()

Removes the weight setting for hidden line.

Return: A reference to this object.

Public Static Functions

HPS.HiddenLineAttributeKit GetDefault ()

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.

Return: A HiddenLineAttributeKit with the default settings.

bool operator!= (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit b)

bool operator== (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit b)