# class ModularSeamSettings

# Properties

Property Description
MaxDeviation The max deviation target for the modular seams.
ModularSeams The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.
Name The name of the ModularSeamSettings object. (Inherited from Object)
ReductionRatio The reduction ratio target for the modular seams.
StopCondition The StopCondition decides whether both or any of the ReductionRatio and MaxDeviation targets should be used.
UseReductionSettingsTargets If true, the reduction ratio and max deviation will be set from the ReductionSettings' targets. However, TriangleCount and OnScreenSize are not valid targets for the modular seam reduction.

# 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 ModularSeamSettings 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 ModularSeamSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the ModularSeamSettings object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the ModularSeamSettings object is valid. (Inherited from Object)
NonNull Returns true if the ModularSeamSettings object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the ModularSeamSettings 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 spModularSeamSettings, and if this is the case, returns the object cast into spModularSeamSettings. (Inherited from Object)

# Properties details

# MaxDeviation

The max deviation target for the modular seams.

    # ModularSeams

    The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.

      # Name

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

        # ReductionRatio

        The reduction ratio target for the modular seams.

          # StopCondition

          The StopCondition decides whether both or any of the ReductionRatio and MaxDeviation targets should be used.

            # UseReductionSettingsTargets

            If true, the reduction ratio and max deviation will be set from the ReductionSettings' targets. However, TriangleCount and OnScreenSize are not valid targets for the modular seam reduction.

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

                                # IsNull

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

                                  # IsSameObjectAs

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

                                    # NonNull

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

                                      # PrintInfo

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