Skip to content
On this page

class HighDensityMeshReductionSettings

The HighDensityMeshReductionSettings settings object for the high density reduction pipeline and processor.

Properties

PropertyDescription
MaxDeviationThe MaxDeviation value, the maximum surface-deviation between the reduced geometry and the original.
MaxDeviationEnabledEnable max deviation as a reduction target. The reducer will stop when the set max deviation has been reached.
NameThe name of the HighDensityMeshReductionSettings object. (Inherited from Object)
OnScreenSizeThe OnScreenSize value, used to calculate the maximum surface-deviation allowed, by assuming errors less than 1 pixel onscreen will not be noticeable.
OnScreenSizeEnabledEnable on screen size as a reduction target. The reducer will stop when the set on screen size has been reached.
ProcessSelectionSetNameThe name of the selection set which should be processed. If not set, all geometries in the scene will be processed.
StopConditionThe 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.

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameterGet a named parameter boolean value. (Inherited from SettingsObject)
GetClassGet the name of the HighDensityMeshReductionSettings class. (Inherited from Object)
GetDoubleParameterGet a named parameter floating point value. (Inherited from SettingsObject)
GetErrorStringReturns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameterGet a named parameter integer value. (Inherited from SettingsObject)
GetStringParameterGet a named parameter string value. (Inherited from SettingsObject)
GetUIntParameterGet a named parameter unsigned integer value. (Inherited from SettingsObject)
IsAReturns true if HighDensityMeshReductionSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the HighDensityMeshReductionSettings object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object)
NonNullReturns true if the HighDensityMeshReductionSettings object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the HighDensityMeshReductionSettings object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetBoolParameterSet a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameterSet a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameterSet a named parameter integer value. (Inherited from SettingsObject)
SetStringParameterSet a named parameter string value. (Inherited from SettingsObject)
SetUIntParameterSet a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNamesSet 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)
ToJSONGet settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettingsValidates the current settings values. (Inherited from SettingsObject)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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

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)

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.

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)