Simplygon 9 Documentation

# class RemeshingSettings

Remeshing settings for the RemeshingProcessor class.

# Properties

Property Description
HardEdgeAngle The normal hard angle cutoff in degrees.
HoleFilling HoleFillling defines how aggresively the remesher will fill holes and cavities. What this does is to measure the volume and hole opening sizes of concavities in the input geometry and fill them in in the remeshing if the concavity is large enough with a small enough opening. This removes a lot of unnessecary geometry and is recommended to be kept at it's default rather than turning it off, it will in the vast majority of cases have a positive effect on the result.
KeepUnprocessedSceneMeshes If false, the processor will remove all geometry and scene nodes which was not selected for processing from the scene. If true, only the geometry in the ProcessSelectionSet will be replaced or updated. If old nodes are kept and a new geometry is added to the scene, it will always be the last child of the scene root. If generating a mappingimage to cast materials, new materialIds will also be appended to the end of the old material table instead of replacing the old ones.
OnScreenSize The on-screen rendering size of the geometry. Allowed values are in the range 20 to 10000 pixels.
ProcessSelectionSetID Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
ProcessSelectionSetName Selects which selection set should be processed. If the selection set is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.
RemeshingMode The remeshing mode, options are Outside, Inside and Manual. RemeshingMode defines if the remeshing processor remeshes the outside or the inside of the input geometry. Manual needs the user to define a position in space that will be considered as outside for the purposes of the remeshing. Position is set with RemeshingModeManualPosition. Hole filling only works with the mode Outside.
SurfaceTransferMode The surface transfer mode.
TransferColors If set, vertex color channels will be sampled from the original mesh.
TransferNormals If set, the vertex normals channel will be sampled from the original mesh.

# Methods

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the RemeshingSettings class.
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 RemeshingSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the RemeshingSettings object is invalid.
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

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spRemeshingSettings, and if this is the case, returns the object cast into spRemeshingSettings.

# Properties details

# HardEdgeAngle

The normal hard angle cutoff in degrees.

    # HoleFilling

    HoleFillling defines how aggresively the remesher will fill holes and cavities. What this does is to measure the volume and hole opening sizes of concavities in the input geometry and fill them in in the remeshing if the concavity is large enough with a small enough opening. This removes a lot of unnessecary geometry and is recommended to be kept at it's default rather than turning it off, it will in the vast majority of cases have a positive effect on the result.

      # KeepUnprocessedSceneMeshes

      If false, the processor will remove all geometry and scene nodes which was not selected for processing from the scene. If true, only the geometry in the ProcessSelectionSet will be replaced or updated. If old nodes are kept and a new geometry is added to the scene, it will always be the last child of the scene root. If generating a mappingimage to cast materials, new materialIds will also be appended to the end of the old material table instead of replacing the old ones.

        # OnScreenSize

        The on-screen rendering size of the geometry. Allowed values are in the range 20 to 10000 pixels.

          # ProcessSelectionSetID

          Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.

            # ProcessSelectionSetName

            Selects which selection set should be processed. If the selection set is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.

              # RemeshingMode

              The remeshing mode, options are Outside, Inside and Manual. RemeshingMode defines if the remeshing processor remeshes the outside or the inside of the input geometry. Manual needs the user to define a position in space that will be considered as outside for the purposes of the remeshing. Position is set with RemeshingModeManualPosition. Hole filling only works with the mode Outside.

                # SurfaceTransferMode

                The surface transfer mode.

                  # TransferColors

                  If set, vertex color channels will be sampled from the original mesh.

                    # TransferNormals

                    If set, the vertex normals channel will be sampled from the original mesh.

                      # Methods details

                      # GetBoolParameter

                      Get a named parameter boolean value.

                        # GetClass

                        Get the name of the RemeshingSettings class.

                          # 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 RemeshingSettings is a or is a descendant of the class named as the type parameter.

                                      # IsNull

                                      Returns true if the RemeshingSettings object is invalid.

                                        # 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.

                                                          # SafeCast

                                                          SafeCast makes sure the input object is of a class that can be cast into spRemeshingSettings, and if this is the case, returns the object cast into spRemeshingSettings.

                                                            ← RepairSettings →