The HPS::HiddenLineAttributeKit class is a user space object, useful for carrying a group attribute settings. More...
#include <hps.h>
Public Member Functions | |
HiddenLineAttributeKit () | |
Initializes an empty kit. More... | |
HiddenLineAttributeKit (HiddenLineAttributeKit const &in_kit) | |
The copy constructor creates a new HiddenLineAttributeKit object that contains the same settings as the source object. More... | |
HiddenLineAttributeKit (HiddenLineAttributeKit &&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. More... | |
HiddenLineAttributeKit & | operator= (HiddenLineAttributeKit &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this HiddenLineAttributeKit thereby avoiding a copy. More... | |
virtual | ~HiddenLineAttributeKit () |
Destroy this kit. More... | |
HPS::Type | ObjectType () const |
void | Set (HiddenLineAttributeKit const &in_kit) |
Copies the source HiddenLineAttributeKit into this object. More... | |
void | Show (HiddenLineAttributeKit &out_kit) const |
Copies this object into the given HiddenLineAttributeKit. More... | |
HiddenLineAttributeKit & | operator= (HiddenLineAttributeKit const &in_kit) |
Copies the source HiddenLineAttributeKit into this object. More... | |
bool | Empty () const |
Indicates whether this object has any values set on it. More... | |
bool | Equals (HiddenLineAttributeKit const &in_kit) const |
Check if the source HiddenLineAttributeKit is equivalent to this object. More... | |
bool | operator== (HiddenLineAttributeKit const &in_kit) const |
Check if the source HiddenLineAttributeKit is equivalent to this object. More... | |
bool | operator!= (HiddenLineAttributeKit const &in_kit) const |
Check if the source HiddenLineAttributeKit is not equivalent to this object. More... | |
HiddenLineAttributeKit & | 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. More... | |
HiddenLineAttributeKit & | SetColor (RGBAColor const &in_color) |
Sets the color to be applied to the hidden lines and markers. More... | |
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. More... | |
HiddenLineAttributeKit & | SetFaceDisplacement (float in_buckets) |
Specifies how many units to push faces away from the camera. More... | |
HiddenLineAttributeKit & | SetLinePattern (char const *in_pattern) |
Specifies the pattern of the hidden lines. More... | |
HiddenLineAttributeKit & | SetLineSorting (bool in_state, float in_threshold=2.0f, Line::SizeUnits in_units=HPS::Line::SizeUnits::Pixels) |
Species whether hidden lines are sorted, and if so, what the threshold for sorting is. More... | |
HiddenLineAttributeKit & | SetRenderFaces (bool in_state) |
Specifies whether triangles will be displayed during a hidden-line rendering. More... | |
HiddenLineAttributeKit & | SetRenderText (bool in_state) |
Specifies whether text will be displayed during a hidden-line rendering. More... | |
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. More... | |
HiddenLineAttributeKit & | SetTransparencyCutoff (float in_zero_to_one) |
Specifies the threshold for when transparent objects are considered opaque. More... | |
HiddenLineAttributeKit & | SetVisibility (bool in_state) |
Specifies whether hidden lines and markers should be displayed. More... | |
HiddenLineAttributeKit & | SetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor) |
Sets the weight of lines drawn in hidden line rendering. More... | |
HiddenLineAttributeKit & | UnsetAlgorithm () |
Removes the hidden line algorithm setting. More... | |
HiddenLineAttributeKit & | UnsetColor () |
Removes the hidden line color setting. More... | |
HiddenLineAttributeKit & | UnsetDimFactor () |
Removes the dim factor setting. More... | |
HiddenLineAttributeKit & | UnsetFaceDisplacement () |
Removes the face displacement setting. More... | |
HiddenLineAttributeKit & | UnsetLinePattern () |
Removes the line pattern setting for hidden lines. More... | |
HiddenLineAttributeKit & | UnsetLineSorting () |
Removes the line sorting setting. More... | |
HiddenLineAttributeKit & | UnsetRenderFaces () |
Removes the face rendering setting. More... | |
HiddenLineAttributeKit & | UnsetRenderText () |
Removes the text rendering setting. More... | |
HiddenLineAttributeKit & | UnsetSilhouetteCleanup () |
Removes the silhouette cleanup setting. More... | |
HiddenLineAttributeKit & | UnsetTransparencyCutoff () |
Removes the transparency cutoff setting. More... | |
HiddenLineAttributeKit & | UnsetVisibility () |
Removes the hidden line visibility setting. More... | |
HiddenLineAttributeKit & | UnsetWeight () |
Removes the weight setting for hidden line. More... | |
HiddenLineAttributeKit & | UnsetEverything () |
Removes all settings from this object. More... | |
bool | ShowAlgorithm (HiddenLine::Algorithm &out_algorithm) const |
Shows the sorting algorithm that will be used to sort faces that have been made visible by the SetRenderFaces method. More... | |
bool | ShowColor (RGBAColor &out_color) const |
Shows the color applied to hidden lines and markers. More... | |
bool | ShowDimFactor (float &out_zero_to_one) const |
Shows the dim factor multiplier applied to each channel of the hidden line color. More... | |
bool | ShowFaceDisplacement (float &out_buckets) const |
Shows the number of units to push faces away from the camera. More... | |
bool | ShowLinePattern (UTF8 &out_pattern) const |
Shows the pattern of the hidden lines. More... | |
bool | ShowLineSorting (bool &out_state, float &out_threshold, Line::SizeUnits &out_units) const |
Shows the hidden line sorting options. More... | |
bool | ShowRenderFaces (bool &out_state) const |
Shows whether triangles will be displayed during a hidden-line rendering. More... | |
bool | ShowRenderText (bool &out_state) const |
Shows whether text will be displayed during a hidden-line rendering. More... | |
bool | ShowSilhouetteCleanup (bool &out_state) const |
Shows whether hidden line rendering should be post-processed to remove visual artifacts of silhouette edges. More... | |
bool | ShowTransparencyCutoff (float &out_zero_to_one) const |
Shows the threshold for when transparent objects are considered opaque. More... | |
bool | ShowVisibility (bool &out_state) const |
Shows whether hidden lines and markers should be displayed. More... | |
bool | ShowWeight (float &out_weight, Line::SizeUnits &out_units) const |
Shows the weight of lines drawn in hidden line rendering. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
static HiddenLineAttributeKit | GetDefault () |
Creates a HiddenLineAttributeKit which contains the default settings. More... | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::HiddenLineAttributeKit |
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.
HPS::HiddenLineAttributeKit::HiddenLineAttributeKit | ( | ) |
Initializes an empty kit.
HPS::HiddenLineAttributeKit::HiddenLineAttributeKit | ( | HiddenLineAttributeKit const & | in_kit | ) |
The copy constructor creates a new HiddenLineAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
HPS::HiddenLineAttributeKit::HiddenLineAttributeKit | ( | HiddenLineAttributeKit && | 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. |
|
virtual |
Destroy this kit.
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS::Object.
bool HPS::HiddenLineAttributeKit::Equals | ( | HiddenLineAttributeKit const & | in_kit | ) | const |
Check if the source HiddenLineAttributeKit is equivalent to this object.
in_kit | The source HiddenLineAttributeKit to compare to this object. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
static |
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.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
bool HPS::HiddenLineAttributeKit::operator!= | ( | HiddenLineAttributeKit const & | in_kit | ) | const |
Check if the source HiddenLineAttributeKit is not equivalent to this object.
in_kit | The source HiddenLineAttributeKit to compare to this object. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::operator= | ( | HiddenLineAttributeKit && | 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. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::operator= | ( | HiddenLineAttributeKit const & | in_kit | ) |
Copies the source HiddenLineAttributeKit into this object.
in_kit | The source HiddenLineAttributeKit to copy. |
bool HPS::HiddenLineAttributeKit::operator== | ( | HiddenLineAttributeKit const & | in_kit | ) | const |
Check if the source HiddenLineAttributeKit is equivalent to this object.
in_kit | The source HiddenLineAttributeKit to compare to this object. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::HiddenLineAttributeKit::Set | ( | HiddenLineAttributeKit const & | in_kit | ) |
Copies the source HiddenLineAttributeKit into this object.
in_kit | The source object to copy. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
HiddenLineAttributeKit& 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.
in_zero_to_one | A multiplier, between [0,1], applied to each channel of the hidden line color. |
HiddenLineAttributeKit& 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.
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. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::SetLineSorting | ( | bool | in_state, |
float | in_threshold = 2.0f , |
||
Line::SizeUnits | in_units = HPS::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 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.
in_state | Should hidden lines be sorted. |
in_threshold | What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted. |
in_units | What units in_threshold is specified in. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
HiddenLineAttributeKit& 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.
in_state | Whether hidden line rendering should be post-processed to remove visual artifacts. |
HiddenLineAttributeKit& 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.
in_zero_to_one | The cutoff value, between [0,1]. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::SetVisibility | ( | bool | in_state | ) |
Specifies whether hidden lines and markers should be displayed.
in_state | The algorithm to be used during hidden line rendering. |
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::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. |
void HPS::HiddenLineAttributeKit::Show | ( | HiddenLineAttributeKit & | out_kit | ) | const |
Copies this object into the given HiddenLineAttributeKit.
out_kit | The HiddenLineAttributeKit to populate with the contents of this object. |
bool HPS::HiddenLineAttributeKit::ShowAlgorithm | ( | HiddenLine::Algorithm & | out_algorithm | ) | const |
Shows the sorting algorithm that will be used to sort faces that have been made visible by the SetRenderFaces method.
out_algorithm | The algorithm used to sort visible faces. |
bool HPS::HiddenLineAttributeKit::ShowColor | ( | RGBAColor & | out_color | ) | const |
Shows the color applied to hidden lines and markers.
out_color | The color of hidden line geometry. |
bool HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::ShowLineSorting | ( | bool & | out_state, |
float & | out_threshold, | ||
Line::SizeUnits & | out_units | ||
) | const |
Shows the hidden line sorting options.
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. |
bool HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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 HPS::HiddenLineAttributeKit::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. |
|
inlinevirtualinherited |
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.
Reimplemented from HPS::Object.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetAlgorithm | ( | ) |
Removes the hidden line algorithm setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetColor | ( | ) |
Removes the hidden line color setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetDimFactor | ( | ) |
Removes the dim factor setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetFaceDisplacement | ( | ) |
Removes the face displacement setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetLinePattern | ( | ) |
Removes the line pattern setting for hidden lines.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetLineSorting | ( | ) |
Removes the line sorting setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetRenderFaces | ( | ) |
Removes the face rendering setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetRenderText | ( | ) |
Removes the text rendering setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetSilhouetteCleanup | ( | ) |
Removes the silhouette cleanup setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetTransparencyCutoff | ( | ) |
Removes the transparency cutoff setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetVisibility | ( | ) |
Removes the hidden line visibility setting.
HiddenLineAttributeKit& HPS::HiddenLineAttributeKit::UnsetWeight | ( | ) |
Removes the weight setting for hidden line.
|
static |