#include <hps.h>
Static Public Attributes | |
| static const HPS::Type | staticType = HPS::Type::HiddenLineAttributeControl |
 Static Public Attributes inherited from HPS::Control | |
| static const HPS::Type | staticType = HPS::Type::Control |
| Static Public Attributes inherited from HPS::Object | |
| static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
| Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
| Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
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/3]
|
explicit |
Initializes a control tied to the segment in_seg.
◆ HiddenLineAttributeControl() [2/3]
| HPS::HiddenLineAttributeControl::HiddenLineAttributeControl | ( | HiddenLineAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
◆ HiddenLineAttributeControl() [3/3]
| HPS::HiddenLineAttributeControl::HiddenLineAttributeControl | ( | HiddenLineAttributeControl && | in_that | ) |
The move constructor creates a HiddenLineAttributeKit by transferring the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a HiddenLineAttributeKit to take the impl from.
◆ ~HiddenLineAttributeControl()
| HPS::HiddenLineAttributeControl::~HiddenLineAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
◆ 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.
◆ operator=() [1/2]
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::operator= | ( | HiddenLineAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a HiddenLineAttributeKit to take the impl from.
- Returns
- A reference to this HiddenLineAttributeKit.
◆ operator=() [2/2]
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::operator= | ( | HiddenLineAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the HiddenLineAttributeControl source.
- Parameters
-
in_that The HiddenLineAttributeControl source of the assignment.
- Returns
- A reference to this HiddenLineAttributeControl.
◆ SetAlgorithm()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetAlgorithm | ( | 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.
- Parameters
-
in_algorithm The algorithm used to sort visible faces.
- Returns
- A reference to this object.
◆ SetColor()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetColor | ( | RGBAColor const & | in_color | ) |
Sets the color to be applied to the hidden lines and markers.
- Parameters
-
in_color The color hidden line geometry should be drawn in.
- Returns
- A reference to this object.
◆ SetDimFactor()
| 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.
- Parameters
-
in_zero_to_one A multiplier, between [0,1], applied to each channel of the hidden line color.
- Returns
- A reference to this object.
◆ SetFaceDisplacement()
| 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.
- Parameters
-
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.
- Returns
- A reference to this object.
◆ SetLinePattern()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetLinePattern | ( | char const * | in_pattern | ) |
Specifies the pattern of the hidden lines.
- Parameters
-
in_pattern The name of a line pattern, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
◆ SetLineSorting()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetLineSorting | ( | bool | in_on, |
| float | in_activation_weight = 2, |
||
| Line::SizeUnits | in_units = Line::SizeUnits::Pixels |
||
| ) |
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_on Whether to sort or not. in_activation_weight Lines thicker than this will be sorted. Thinner ones will be ignored. in_units Units applied to in_activation_weight.
- Returns
- A reference to this object.
◆ SetRenderFaces()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetRenderFaces | ( | bool | in_state | ) |
Specifies whether triangles will be displayed during a hidden-line rendering.
- Parameters
-
in_state Whether triangles will displayed during a hidden-line rendering.
- Returns
- A reference to this object.
◆ SetRenderText()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetRenderText | ( | bool | in_state | ) |
Specifies whether text will be displayed during a hidden-line rendering.
- Parameters
-
in_state Whether text will displayed during a hidden-line rendering.
- Returns
- A reference to this object.
◆ SetSilhouetteCleanup()
| 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.
- Parameters
-
in_state Whether hidden line rendering should be post-processed to remove visual artifacts.
- Returns
- A reference to this object.
◆ SetTransparencyCutoff()
| 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.
- Parameters
-
in_zero_to_one The cutoff value, between [0,1].
- Returns
- A reference to this object.
◆ SetVisibility()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetVisibility | ( | bool | in_state | ) |
Specifies whether hidden lines and markers should be displayed.
- Parameters
-
in_state The algorithm to be used during hidden line rendering.
- Returns
- A reference to this object.
◆ SetWeight()
| HiddenLineAttributeControl& HPS::HiddenLineAttributeControl::SetWeight | ( | float | in_weight, |
| Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
| ) |
Sets the weight of lines drawn in hidden line rendering.
- Parameters
-
in_weight The weight value for hidden lines. in_units The units applied to in_weight.
- Returns
- A reference to this object.
◆ ShowAlgorithm()
| bool HPS::HiddenLineAttributeControl::ShowAlgorithm | ( | HiddenLine::Algorithm & | out_algorithm | ) | const |
Shows the algorithm to be used during hidden line rendering.
- Parameters
-
out_algorithm The algorithm used for hidden line rendering.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowColor()
| bool HPS::HiddenLineAttributeControl::ShowColor | ( | RGBAColor & | out_color | ) | const |
Shows the color applied to hidden lines and markers.
- Parameters
-
out_color The color of hidden line geometry.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowDimFactor()
| bool HPS::HiddenLineAttributeControl::ShowDimFactor | ( | float & | out_zero_to_one | ) | const |
Shows the dim factor multiplier applied to each channel of the hidden line color.
- Parameters
-
out_zero_to_one A 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 | ( | float & | out_buckets | ) | const |
Shows the number of units to push faces away from the camera.
- Parameters
-
out_buckets The 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 | ( | UTF8 & | out_pattern | ) | const |
Shows the pattern of the hidden lines.
- Parameters
-
out_pattern The 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 | ( | bool & | out_state, |
| float & | out_threshold, | ||
| Line::SizeUnits & | out_units | ||
| ) | const |
Shows the hidden line sorting options.
- Parameters
-
out_state Whether hidden line sorting is on or off. out_threshold The minimum width at which hidden lines are sorted. out_units The units that out_threshold is measured in.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowRenderFaces()
| bool HPS::HiddenLineAttributeControl::ShowRenderFaces | ( | bool & | out_state | ) | const |
Shows whether triangles will be displayed during a hidden-line rendering.
- Parameters
-
out_state Whether triangles will displayed during a hidden-line rendering.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowRenderText()
| bool HPS::HiddenLineAttributeControl::ShowRenderText | ( | bool & | out_state | ) | const |
Shows whether text will be displayed during a hidden-line rendering.
- Parameters
-
out_state Whether text will displayed during a hidden-line rendering.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowSilhouetteCleanup()
| bool HPS::HiddenLineAttributeControl::ShowSilhouetteCleanup | ( | bool & | out_state | ) | const |
Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges.
- Parameters
-
out_state Whether 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 | ( | float & | out_zero_to_one | ) | const |
Shows the threshold for when transparent objects are considered opaque.
- Parameters
-
out_zero_to_one The cutoff value, between [0,1].
- Returns
- true if the setting is valid, false otherwise.
◆ ShowVisibility()
| bool HPS::HiddenLineAttributeControl::ShowVisibility | ( | bool & | out_state | ) | const |
Shows whether hidden lines and markers should be displayed.
- Parameters
-
out_state Whether hidden lines and markers should be displayed.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowWeight()
| bool HPS::HiddenLineAttributeControl::ShowWeight | ( | float & | out_weight, |
| Line::SizeUnits & | out_units | ||
| ) | const |
Shows the weight of lines drawn in hidden line rendering.
- Parameters
-
out_weight The weight value for hidden lines. out_units The units applied to in_weight.
- Returns
- true if the setting is valid, false otherwise.
◆ 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()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetColor()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetDimFactor()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetEverything()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetFaceDisplacement()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetLinePattern()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetLineSorting()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetRenderFaces()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetRenderText()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetSilhouetteCleanup()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetTransparencyCutoff()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetVisibility()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
◆ UnsetWeight()
| HiddenLineAttributeControl& 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().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h