Skip to content
On this page

class PartRemoverSettings

The PartRemoverSettings settings object for the PartRemover tool as well as Reduction pipeline and processor.

Properties

PropertyDescription
NameThe name of the PartRemoverSettings object. (Inherited from Object)
PartRemoverThresholdTypeDetermines which kind of size threshold will be used.
ThresholdThe threshold value. How it is interpreted depends on the ThresholdType Enum.
UseSurfaceAreaIf set, objects with small surface area but big diameter will also be removed.
UseVertexLocksIf set, objects containing locked vertices will not be removed.

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 PartRemoverSettings 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 PartRemoverSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the PartRemoverSettings object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the PartRemoverSettings object is valid. (Inherited from Object)
NonNullReturns true if the PartRemoverSettings object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the PartRemoverSettings 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 spPartRemoverSettings, and if this is the case, returns the object cast into spPartRemoverSettings. (Inherited from Object)

Properties details

Name

The name of the PartRemoverSettings object. (Inherited from Object)

PartRemoverThresholdType

Determines which kind of size threshold will be used.

Threshold

The threshold value. How it is interpreted depends on the ThresholdType Enum.

UseSurfaceArea

If set, objects with small surface area but big diameter will also be removed.

UseVertexLocks

If set, objects containing locked vertices will not be removed.

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

IsNull

Returns true if the PartRemoverSettings object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the PartRemoverSettings object is valid. (Inherited from Object)

NonNull

Returns true if the PartRemoverSettings object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the PartRemoverSettings 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 spPartRemoverSettings, and if this is the case, returns the object cast into spPartRemoverSettings. (Inherited from Object)