#include <hps.h>
The HiddenLineAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HiddenLineAttributeKit::GetDefault() will return a kit with values found in this table.
HiddenLineAttributeKit::HiddenLineAttributeKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new HiddenLineAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
virtual HiddenLineAttributeKit::~HiddenLineAttributeKit |
( |
| ) |
|
|
virtual |
bool HiddenLineAttributeKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from Object.
Check if the source HiddenLineAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
- Returns
- A HiddenLineAttributeKit with the default settings.
Type HiddenLineAttributeKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from Object.
Check if the source HiddenLineAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
Check if the source HiddenLineAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
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.
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.
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 "z buckets" to push faces away from the camera. Negative values will move faces toward the camera, potentially obscuring some lines. |
- Returns
- A reference to this object.
- See also
- DrawingAttributeKit::SetFaceDisplacement()
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.
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.
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.
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.
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.
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.
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.
Shows the sorting algorithm that will be used to sort faces that have been made visible by the SetRenderFaces method.
- Parameters
-
out_algorithm | The algorithm used to sort visible faces. |
- Returns
- true if the setting is valid, false otherwise.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
bool HiddenLineAttributeKit::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.
Removes the hidden line algorithm setting.
- Returns
- A reference to this object.
Removes the hidden line color setting.
- Returns
- A reference to this object.
Removes the dim factor setting.
- Returns
- A reference to this object.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the face displacement setting.
- Returns
- A reference to this object.
Removes the line pattern setting for hidden lines.
- Returns
- A reference to this object.
Removes the face rendering setting.
- Returns
- A reference to this object.
Removes the text rendering setting.
- Returns
- A reference to this object.
Removes the silhouette cleanup setting.
- Returns
- A reference to this object.
Removes the transparency cutoff setting.
- Returns
- A reference to this object.
Removes the hidden line visibility setting.
- Returns
- A reference to this object.
Removes the weight setting for hidden line.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: