REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
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.
|
explicit |
Initializes a control tied to the segment in_seg.
HiddenLineAttributeControl::HiddenLineAttributeControl | ( | HiddenLineAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
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.
in_that | An rvalue reference to a HiddenLineAttributeKit to take the impl from. |
HiddenLineAttributeControl::~HiddenLineAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Control.
HiddenLineAttributeControl& HiddenLineAttributeControl::operator= | ( | HiddenLineAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy.
in_that | An rvalue reference to a HiddenLineAttributeKit to take the impl from. |
HiddenLineAttributeControl& HiddenLineAttributeControl::operator= | ( | HiddenLineAttributeControl const & | in_that | ) |
Share the smart-pointer.
HiddenLineAttributeControl& 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.
in_algorithm | The algorithm used to sort visible faces. |
HiddenLineAttributeControl& HiddenLineAttributeControl::SetColor | ( | RGBAColor const & | 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. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& HiddenLineAttributeControl::SetLinePattern | ( | char const * | in_pattern | ) |
Specifies the pattern of the hidden lines.
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& 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]. |
HiddenLineAttributeControl& 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. |
HiddenLineAttributeControl& HiddenLineAttributeControl::SetWeight | ( | float | in_weight, |
Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
) |
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. |
bool HiddenLineAttributeControl::ShowAlgorithm | ( | HiddenLine::Algorithm & | out_algorithm | ) | const |
Shows the algorithm to be used during hidden line rendering.
out_algorithm | The algorithm used for hidden line rendering. |
bool HiddenLineAttributeControl::ShowColor | ( | RGBAColor & | out_color | ) | const |
Shows the color applied to hidden lines and markers.
out_color | The color of hidden line geometry. |
bool HiddenLineAttributeControl::ShowDimFactor | ( | float & | out_zero_to_one | ) | const |
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 HiddenLineAttributeControl::ShowFaceDisplacement | ( | float & | out_buckets | ) | const |
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 HiddenLineAttributeControl::ShowLinePattern | ( | UTF8 & | out_pattern | ) | const |
Shows the pattern of the hidden lines.
out_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
bool HiddenLineAttributeControl::ShowRenderFaces | ( | bool & | out_state | ) | const |
Shows whether triangles will be displayed during a hidden-line rendering.
out_state | Whether triangles will displayed during a hidden-line rendering. |
bool HiddenLineAttributeControl::ShowRenderText | ( | bool & | out_state | ) | const |
Shows whether text will be displayed during a hidden-line rendering.
out_state | Whether text will displayed during a hidden-line rendering. |
bool HiddenLineAttributeControl::ShowSilhouetteCleanup | ( | bool & | out_state | ) | const |
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 HiddenLineAttributeControl::ShowTransparencyCutoff | ( | float & | out_zero_to_one | ) | const |
Shows the threshold for when transparent objects are considered opaque.
out_zero_to_one | The cutoff value, between [0,1]. |
bool HiddenLineAttributeControl::ShowVisibility | ( | bool & | out_state | ) | const |
Shows whether hidden lines and markers should be displayed.
out_state | Whether hidden lines and markers should be displayed. |
bool HiddenLineAttributeControl::ShowWeight | ( | float & | out_weight, |
Line::SizeUnits & | out_units | ||
) | const |
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. |
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetAlgorithm | ( | ) |
Removes the hidden line algorithm setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetColor | ( | ) |
Removes the hidden line color setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetDimFactor | ( | ) |
Removes the dim factor setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetFaceDisplacement | ( | ) |
Removes the face displacement setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetLinePattern | ( | ) |
Removes the line pattern setting for hidden lines.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetRenderFaces | ( | ) |
Removes the face rendering setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetRenderText | ( | ) |
Removes the text rendering setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetSilhouetteCleanup | ( | ) |
Removes the silhouette cleanup setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetTransparencyCutoff | ( | ) |
Removes the transparency cutoff setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetVisibility | ( | ) |
Removes the hidden line visibility setting.
HiddenLineAttributeControl& HiddenLineAttributeControl::UnsetWeight | ( | ) |
Removes the weight setting for hidden line.