class HighDensityMeshReductionSettings
The HighDensityMeshReductionSettings settings object for the high density reduction pipeline and processor.
Properties
| Property | Description |
|---|---|
| BorderImportance | The importance value of the hard, non-continuous borders in the geometry field data, like normals, UVs, or colors. This importance specifically targets how much existing borders are allowed to move, and does not influence stretch inside continuous areas. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| ColorImportance | The importance value of the vertex-colors of the Geometry, both the boundary between triangles with different colors, as well as how the colors interpolate over the surface of the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| GeometryImportance | The importance value of the position of the vertices and triangles of the Geometry, or the silhouette of the Geometry. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| GroupImportance | The importance value of the boundary between triangles from different sub-geometries. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| Isotropicity | The Isotropicity value is a measure of how isotropic the triangles will be in the processed mesh. A low value will create more sliver triangles, but adapts tighter to the mesh. A high value requires more triangles to adapt to the original mesh, but creates more evenly spaced triangles which are closer to being equilateral. |
| MaterialImportance | The importance value of the boundary between triangles with different materials. For example, if triangles with a metallic material are connected to triangles with a wood material, this setting will determine how important it is to keep the border between them intact. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| MaxDeviation | The MaxDeviation value, the maximum surface-deviation between the reduced geometry and the original. |
| MaxDeviationEnabled | Enable max deviation as a reduction target. The reducer will stop when the set max deviation has been reached. |
| Name | The name of the HighDensityMeshReductionSettings object. (Inherited from Object) |
| NormalImportance | The importance value of the vertex-normals of the Geometry, both the sharp edges, as well as how the normals interpolate over the surface of the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| OnScreenSize | The OnScreenSize value, used to calculate the maximum surface-deviation allowed, by assuming errors less than 1 pixel onscreen will not be noticeable. |
| OnScreenSizeEnabled | Enable on screen size as a reduction target. The reducer will stop when the set on screen size has been reached. |
| ProcessSelectionSetName | The name of the selection set which should be processed. If not set, all geometries in the scene will be processed. |
| StopCondition | The stop condition for the reducer to finish processing. Any -> the reducer will stop when any single one of the set reduction targets have been reached. All -> the reducer will stop when all enabled reduction targets have been reached. |
| TexcoordImportance | The importance value of the UV coordinates of the Geometry, both the boundary of the UV charts, as well as the UV stretch across the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0 |
| TriangleCount | The TriangleCount value, the target to number of triangles to reduce to. |
| TriangleCountEnabled | Enable on triangle count as a reduction target. The reducer will stop when the number of triangles has been reached. |
| TriangleRatio | The TriangleRatio value, the target to number of triangles to reduce to, defined as a ratio vs the original triangle count. |
| TriangleRatioEnabled | Enable triangle ratio as a reduction target. The reducer will stop when the set ratio of triangles has been reached. |
| UseColorRanker | If set, reduction will take the first vertex color field into account when deciding which vertices to keep and which to remove. |
| UseNormalRanker | If set, reduction will take vertex normals into account when deciding which vertices to keep and which to remove. |
| UseTexcoordRanker | If set, reduction will take the first texcoord field into account when deciding which vertices to keep and which to remove. |
Methods
| Method | Description |
|---|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the HighDensityMeshReductionSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if HighDensityMeshReductionSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the HighDensityMeshReductionSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the HighDensityMeshReductionSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
Static methods
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spHighDensityMeshReductionSettings, and if this is the case, returns the object cast into spHighDensityMeshReductionSettings. (Inherited from Object) |
Properties details
BorderImportance
The importance value of the hard, non-continuous borders in the geometry field data, like normals, UVs, or colors. This importance specifically targets how much existing borders are allowed to move, and does not influence stretch inside continuous areas. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
ColorImportance
The importance value of the vertex-colors of the Geometry, both the boundary between triangles with different colors, as well as how the colors interpolate over the surface of the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
GeometryImportance
The importance value of the position of the vertices and triangles of the Geometry, or the silhouette of the Geometry. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
GroupImportance
The importance value of the boundary between triangles from different sub-geometries. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
Isotropicity
The Isotropicity value is a measure of how isotropic the triangles will be in the processed mesh. A low value will create more sliver triangles, but adapts tighter to the mesh. A high value requires more triangles to adapt to the original mesh, but creates more evenly spaced triangles which are closer to being equilateral.
MaterialImportance
The importance value of the boundary between triangles with different materials. For example, if triangles with a metallic material are connected to triangles with a wood material, this setting will determine how important it is to keep the border between them intact. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
MaxDeviation
The MaxDeviation value, the maximum surface-deviation between the reduced geometry and the original.
MaxDeviationEnabled
Enable max deviation as a reduction target. The reducer will stop when the set max deviation has been reached.
Name
The name of the HighDensityMeshReductionSettings object. (Inherited from Object)
NormalImportance
The importance value of the vertex-normals of the Geometry, both the sharp edges, as well as how the normals interpolate over the surface of the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
OnScreenSize
The OnScreenSize value, used to calculate the maximum surface-deviation allowed, by assuming errors less than 1 pixel onscreen will not be noticeable.
OnScreenSizeEnabled
Enable on screen size as a reduction target. The reducer will stop when the set on screen size has been reached.
ProcessSelectionSetName
The name of the selection set which should be processed. If not set, all geometries in the scene will be processed.
StopCondition
The stop condition for the reducer to finish processing. Any -> the reducer will stop when any single one of the set reduction targets have been reached. All -> the reducer will stop when all enabled reduction targets have been reached.
TexcoordImportance
The importance value of the UV coordinates of the Geometry, both the boundary of the UV charts, as well as the UV stretch across the triangles. The importance is relative to the values of the other mesh features (or disabling an importance entirely by setting it to 0). A higher number means higher importance. Default is 1.0
TriangleCount
The TriangleCount value, the target to number of triangles to reduce to.
TriangleCountEnabled
Enable on triangle count as a reduction target. The reducer will stop when the number of triangles has been reached.
TriangleRatio
The TriangleRatio value, the target to number of triangles to reduce to, defined as a ratio vs the original triangle count.
TriangleRatioEnabled
Enable triangle ratio as a reduction target. The reducer will stop when the set ratio of triangles has been reached.
UseColorRanker
If set, reduction will take the first vertex color field into account when deciding which vertices to keep and which to remove.
UseNormalRanker
If set, reduction will take vertex normals into account when deciding which vertices to keep and which to remove.
UseTexcoordRanker
If set, reduction will take the first texcoord field into account when deciding which vertices to keep and which to remove.
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameter
Get a named parameter boolean value.
GetClass
Get the name of the HighDensityMeshReductionSettings class. (Inherited from Object)
GetDoubleParameter
Get a named parameter floating point value.
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
GetIntParameter
Get a named parameter integer value.
GetStringParameter
Get a named parameter string value.
GetUIntParameter
Get a named parameter unsigned integer value.
IsA
Returns true if HighDensityMeshReductionSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the HighDensityMeshReductionSettings object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object)
NonNull
Returns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the HighDensityMeshReductionSettings object to the log. (Inherited from Object)
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
SetBoolParameter
Set a named parameter boolean value.
SetDoubleParameter
Set a named parameter floating point value.
SetIntParameter
Set a named parameter integer value.
SetStringParameter
Set a named parameter string value.
SetUIntParameter
Set a named parameter unsigned integer value.
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
ToJSON
Get settings as JSON for debugging purposes.
ValidateSettings
Validates the current settings values.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spHighDensityMeshReductionSettings, and if this is the case, returns the object cast into spHighDensityMeshReductionSettings. (Inherited from Object)