REFERENCE MANUAL
The HiddenLineAttributeControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
HiddenLineAttributeControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
HiddenLineAttributeControl (HPS.HiddenLineAttributeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
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. More... | |
HPS.HiddenLineAttributeControl | SetColor (HPS.RGBAColor in_color) |
Sets the color to be applied to the hidden lines and markers. More... | |
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. More... | |
HPS.HiddenLineAttributeControl | SetFaceDisplacement (float in_buckets) |
Specifies how many units to push faces away from the camera. More... | |
HPS.HiddenLineAttributeControl | SetLinePattern (string in_pattern) |
Specifies the pattern of the hidden lines. More... | |
HPS.HiddenLineAttributeControl | SetRenderFaces (bool in_state) |
Specifies whether triangles will be displayed during a hidden-line rendering. More... | |
HPS.HiddenLineAttributeControl | SetRenderText (bool in_state) |
Specifies whether text will be displayed during a hidden-line rendering. More... | |
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. More... | |
HPS.HiddenLineAttributeControl | SetTransparencyCutoff (float in_zero_to_one) |
Specifies the threshold for when transparent objects are considered opaque. More... | |
HPS.HiddenLineAttributeControl | SetVisibility (bool in_state) |
Specifies whether hidden lines and markers should be displayed. More... | |
HPS.HiddenLineAttributeControl | SetWeight (float in_weight, HPS.Line.SizeUnits in_units) |
Sets the weight of lines drawn in hidden line rendering. More... | |
HPS.HiddenLineAttributeControl | SetWeight (float in_weight) |
Sets the weight of lines drawn in hidden line rendering. More... | |
bool | ShowAlgorithm (out HPS.HiddenLine.Algorithm out_algorithm) |
Shows the algorithm to be used during hidden line rendering. More... | |
bool | ShowColor (out HPS.RGBAColor out_color) |
Shows the color applied to hidden lines and markers. More... | |
bool | ShowDimFactor (out float out_zero_to_one) |
Shows the dim factor multiplier applied to each channel of the hidden line color. More... | |
bool | ShowFaceDisplacement (out float out_buckets) |
Shows the number of units to push faces away from the camera. More... | |
bool | ShowLinePattern (out string out_pattern) |
Shows the pattern of the hidden lines. More... | |
bool | ShowRenderFaces (out bool out_state) |
Shows whether triangles will be displayed during a hidden-line rendering. More... | |
bool | ShowRenderText (out bool out_state) |
Shows whether text will be displayed during a hidden-line rendering. More... | |
bool | ShowSilhouetteCleanup (out bool out_state) |
Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges. More... | |
bool | ShowTransparencyCutoff (out float out_zero_to_one) |
Shows the threshold for when transparent objects are considered opaque. More... | |
bool | ShowVisibility (out bool out_state) |
Shows whether hidden lines and markers should be displayed. More... | |
bool | ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units) |
Shows the weight of lines drawn in hidden line rendering. More... | |
HPS.HiddenLineAttributeControl | UnsetAlgorithm () |
Removes the hidden line algorithm setting. More... | |
HPS.HiddenLineAttributeControl | UnsetColor () |
Removes the hidden line color setting. More... | |
HPS.HiddenLineAttributeControl | UnsetDimFactor () |
Removes the dim factor setting. More... | |
HPS.HiddenLineAttributeControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.HiddenLineAttributeControl | UnsetFaceDisplacement () |
Removes the face displacement setting. More... | |
HPS.HiddenLineAttributeControl | UnsetLinePattern () |
Removes the line pattern setting for hidden lines. More... | |
HPS.HiddenLineAttributeControl | UnsetRenderFaces () |
Removes the face rendering setting. More... | |
HPS.HiddenLineAttributeControl | UnsetRenderText () |
Removes the text rendering setting. More... | |
HPS.HiddenLineAttributeControl | UnsetSilhouetteCleanup () |
Removes the silhouette cleanup setting. More... | |
HPS.HiddenLineAttributeControl | UnsetTransparencyCutoff () |
Removes the transparency cutoff setting. More... | |
HPS.HiddenLineAttributeControl | UnsetVisibility () |
Removes the hidden line visibility setting. More... | |
HPS.HiddenLineAttributeControl | UnsetWeight () |
Removes the weight setting for hidden line. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 HiddenLineAttributeControl.
HPS.HiddenLineAttributeControl.HiddenLineAttributeControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.HiddenLineAttributeControl.HiddenLineAttributeControl | ( | HPS.HiddenLineAttributeControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.HiddenLineAttributeControl 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.
in_algorithm | The algorithm used to sort visible faces. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetColor | ( | HPS.RGBAColor | in_color | ) |
Sets the color to be applied to the hidden lines and markers.
in_color | The color hidden line geometry should be drawn in. |
HPS.HiddenLineAttributeControl 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.
in_zero_to_one | A multiplier, between [0,1], applied to each channel of the hidden line color. |
HPS.HiddenLineAttributeControl 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.
in_buckets | The number of "z buckets" to push faces away from the camera. Negative values will move faces toward the camera, potentially obscuring some lines. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetLinePattern | ( | string | in_pattern | ) |
Specifies the pattern of the hidden lines.
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetRenderFaces | ( | bool | in_state | ) |
Specifies whether triangles will be displayed during a hidden-line rendering.
in_state | Whether triangles will displayed during a hidden-line rendering. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetRenderText | ( | bool | in_state | ) |
Specifies whether text will be displayed during a hidden-line rendering.
in_state | Whether text will displayed during a hidden-line rendering. |
HPS.HiddenLineAttributeControl 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.
in_state | Whether hidden line rendering should be post-processed to remove visual artifacts. |
HPS.HiddenLineAttributeControl 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.
in_zero_to_one | The cutoff value, between [0,1]. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetVisibility | ( | bool | in_state | ) |
Specifies whether hidden lines and markers should be displayed.
in_state | The algorithm to be used during hidden line rendering. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetWeight | ( | float | in_weight, |
HPS.Line.SizeUnits | in_units | ||
) |
Sets the weight of lines drawn in hidden line rendering.
in_weight | The weight value for hidden lines. |
in_units | The units applied to in_weight. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.SetWeight | ( | float | in_weight | ) |
Sets the weight of lines drawn in hidden line rendering.
in_weight | The weight value for hidden lines. |
bool HPS.HiddenLineAttributeControl.ShowAlgorithm | ( | out HPS.HiddenLine.Algorithm | out_algorithm | ) |
Shows the algorithm to be used during hidden line rendering.
out_algorithm | The algorithm used for hidden line rendering. |
bool HPS.HiddenLineAttributeControl.ShowColor | ( | out HPS.RGBAColor | out_color | ) |
Shows the color applied to hidden lines and markers.
out_color | The color of hidden line geometry. |
bool HPS.HiddenLineAttributeControl.ShowDimFactor | ( | out float | out_zero_to_one | ) |
Shows the dim factor multiplier applied to each channel of the hidden line color.
out_zero_to_one | A multiplier, between [0,1], applied to each channel of the hidden line color. |
bool HPS.HiddenLineAttributeControl.ShowFaceDisplacement | ( | out float | out_buckets | ) |
Shows the number of units to push faces away from the camera.
out_buckets | The number of "z buckets" to push faces away from the camera. |
bool HPS.HiddenLineAttributeControl.ShowLinePattern | ( | out string | out_pattern | ) |
Shows the pattern of the hidden lines.
out_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
bool HPS.HiddenLineAttributeControl.ShowRenderFaces | ( | out bool | out_state | ) |
Shows whether triangles will be displayed during a hidden-line rendering.
out_state | Whether triangles will displayed during a hidden-line rendering. |
bool HPS.HiddenLineAttributeControl.ShowRenderText | ( | out bool | out_state | ) |
Shows whether text will be displayed during a hidden-line rendering.
out_state | Whether text will displayed during a hidden-line rendering. |
bool HPS.HiddenLineAttributeControl.ShowSilhouetteCleanup | ( | out bool | out_state | ) |
Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges.
out_state | Whether hidden line rendering should be post-processed to remove visual artifacts. |
bool HPS.HiddenLineAttributeControl.ShowTransparencyCutoff | ( | out float | out_zero_to_one | ) |
Shows the threshold for when transparent objects are considered opaque.
out_zero_to_one | The cutoff value, between [0,1]. |
bool HPS.HiddenLineAttributeControl.ShowVisibility | ( | out bool | out_state | ) |
Shows whether hidden lines and markers should be displayed.
out_state | Whether hidden lines and markers should be displayed. |
bool HPS.HiddenLineAttributeControl.ShowWeight | ( | out float | out_weight, |
out HPS.Line.SizeUnits | out_units | ||
) |
Shows the weight of lines drawn in hidden line rendering.
out_weight | The weight value for hidden lines. |
out_units | The units applied to in_weight. |
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetAlgorithm | ( | ) |
Removes the hidden line algorithm setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetColor | ( | ) |
Removes the hidden line color setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetDimFactor | ( | ) |
Removes the dim factor setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetFaceDisplacement | ( | ) |
Removes the face displacement setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetLinePattern | ( | ) |
Removes the line pattern setting for hidden lines.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetRenderFaces | ( | ) |
Removes the face rendering setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetRenderText | ( | ) |
Removes the text rendering setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetSilhouetteCleanup | ( | ) |
Removes the silhouette cleanup setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetTransparencyCutoff | ( | ) |
Removes the transparency cutoff setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetVisibility | ( | ) |
Removes the hidden line visibility setting.
HPS.HiddenLineAttributeControl HPS.HiddenLineAttributeControl.UnsetWeight | ( | ) |
Removes the weight setting for hidden line.