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. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.HiddenLineAttributeKit in_kit) |
Check if the source HiddenLineAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
HiddenLineAttributeKit () | |
Initializes an empty kit. More... | |
HiddenLineAttributeKit (HPS.HiddenLineAttributeKit in_kit) | |
The copy constructor creates a new HiddenLineAttributeKit object that contains the same settings as the source object. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.HiddenLineAttributeKit in_kit) |
Copies the source HiddenLineAttributeKit into this object. More... | |
HPS.HiddenLineAttributeKit | 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. More... | |
HPS.HiddenLineAttributeKit | SetColor (HPS.RGBAColor in_color) |
Sets the color to be applied to the hidden lines and markers. More... | |
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. More... | |
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. More... | |
HPS.HiddenLineAttributeKit | SetLinePattern (string in_pattern) |
Specifies the pattern of the hidden lines. More... | |
HPS.HiddenLineAttributeKit | SetRenderFaces (bool in_state) |
Specifies whether triangles will be displayed during a hidden-line rendering. More... | |
HPS.HiddenLineAttributeKit | SetRenderText (bool in_state) |
Specifies whether text will be displayed during a hidden-line rendering. More... | |
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. More... | |
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. More... | |
HPS.HiddenLineAttributeKit | SetVisibility (bool in_state) |
Specifies whether hidden lines and markers should be displayed. More... | |
HPS.HiddenLineAttributeKit | SetWeight (float in_weight, HPS.Line.SizeUnits in_units) |
Sets the weight of lines drawn in hidden line rendering. More... | |
HPS.HiddenLineAttributeKit | SetWeight (float in_weight) |
Sets the weight of lines drawn in hidden line rendering. More... | |
void | Show (out HPS.HiddenLineAttributeKit out_kit) |
Copies this object into the given HiddenLineAttributeKit. More... | |
bool | ShowAlgorithm (out HPS.HiddenLine.Algorithm out_algorithm) |
Shows the sorting algorithm that will be used to sort faces that have been made visible by the SetRenderFaces method. 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.HiddenLineAttributeKit | UnsetAlgorithm () |
Removes the hidden line algorithm setting. More... | |
HPS.HiddenLineAttributeKit | UnsetColor () |
Removes the hidden line color setting. More... | |
HPS.HiddenLineAttributeKit | UnsetDimFactor () |
Removes the dim factor setting. More... | |
HPS.HiddenLineAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.HiddenLineAttributeKit | UnsetFaceDisplacement () |
Removes the face displacement setting. More... | |
HPS.HiddenLineAttributeKit | UnsetLinePattern () |
Removes the line pattern setting for hidden lines. More... | |
HPS.HiddenLineAttributeKit | UnsetRenderFaces () |
Removes the face rendering setting. More... | |
HPS.HiddenLineAttributeKit | UnsetRenderText () |
Removes the text rendering setting. More... | |
HPS.HiddenLineAttributeKit | UnsetSilhouetteCleanup () |
Removes the silhouette cleanup setting. More... | |
HPS.HiddenLineAttributeKit | UnsetTransparencyCutoff () |
Removes the transparency cutoff setting. More... | |
HPS.HiddenLineAttributeKit | UnsetVisibility () |
Removes the hidden line visibility setting. More... | |
HPS.HiddenLineAttributeKit | UnsetWeight () |
Removes the weight setting for hidden line. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.HiddenLineAttributeKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit b) |
static bool | operator== (HPS.HiddenLineAttributeKit a, HPS.HiddenLineAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new HiddenLineAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source HiddenLineAttributeKit is equivalent to this object.
in_kit | The source HiddenLineAttributeKit to compare to this object. |
|
inlinestatic |
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.
|
inlinevirtual |
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.
|
inline |
Copies the source HiddenLineAttributeKit into this object.
in_kit | The source object to copy. |
|
inline |
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. |
|
inline |
Sets the color to be applied to the hidden lines and markers.
in_color | The color hidden line geometry should be drawn in. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Specifies the pattern of the hidden lines.
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
|
inline |
Specifies whether triangles will be displayed during a hidden-line rendering.
in_state | Whether triangles will displayed during a hidden-line rendering. |
|
inline |
Specifies whether text will be displayed during a hidden-line rendering.
in_state | Whether text will displayed during a hidden-line rendering. |
|
inline |
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. |
|
inline |
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]. |
|
inline |
Specifies whether hidden lines and markers should be displayed.
in_state | The algorithm to be used during hidden line rendering. |
|
inline |
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. |
|
inline |
Sets the weight of lines drawn in hidden line rendering.
in_weight | The weight value for hidden lines. |
|
inline |
Copies this object into the given HiddenLineAttributeKit.
out_kit | The HiddenLineAttributeKit to populate with the contents of this object. |
|
inline |
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. |
|
inline |
Shows the color applied to hidden lines and markers.
out_color | The color of hidden line geometry. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Shows the pattern of the hidden lines.
out_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
|
inline |
Shows whether triangles will be displayed during a hidden-line rendering.
out_state | Whether triangles will displayed during a hidden-line rendering. |
|
inline |
Shows whether text will be displayed during a hidden-line rendering.
out_state | Whether text will displayed during a hidden-line rendering. |
|
inline |
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. |
|
inline |
Shows the threshold for when transparent objects are considered opaque.
out_zero_to_one | The cutoff value, between [0,1]. |
|
inline |
Shows whether hidden lines and markers should be displayed.
out_state | Whether hidden lines and markers should be displayed. |
|
inline |
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. |
|
inline |
Removes the hidden line algorithm setting.
|
inline |
Removes the hidden line color setting.
|
inline |
Removes the dim factor setting.
|
inline |
Removes all settings from this object.
|
inline |
Removes the face displacement setting.
|
inline |
Removes the line pattern setting for hidden lines.
|
inline |
Removes the face rendering setting.
|
inline |
Removes the text rendering setting.
|
inline |
Removes the silhouette cleanup setting.
|
inline |
Removes the transparency cutoff setting.
|
inline |
Removes the hidden line visibility setting.
|
inline |
Removes the weight setting for hidden line.