# class RemeshingLegacySettings

Remeshing settings for the RemeshingLegacyProcessor class. The remesher creates a completely new lightweight mesh from the input geometry, and is intended to be viewed from the outside. Here you will set the OnScreenSize (larger numbers means a more detailed mesh), merge distance (which fills in smaller gaps) and a cutting plane (where all parts of the input mesh on the far side of that plane will be culled).

# Properties

Property Description
ClippingGeometryEmptySpaceOverride The clipping geometry empty space override coordinate.
ClippingGeometrySelectionSetID The ID of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.
ClippingGeometrySelectionSetName The name of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.
CuttingPlaneSelectionSetID The ID of the selection set containing all the cutting planes that should be used. If set to -1, all cutting planes are selected. Cutting planes will only be used if UseCuttingPlanes is true. If both selection set name and ID are set, the name will be used.
CuttingPlaneSelectionSetName The name of the selection set containing all the cutting planes that should be used. If the name is not found, all cutting planes are selected. If both selection set name and ID are set, the name will be used.
EmptySpaceOverride The empty space override coordinate.
HardEdgeAngle The normal hard angle cutoff in degrees.
MaxTriangleSize The maximum size in pixels of a generated triangle Any value from 5 pixels and above is allowed. If set to 0, there will be no restriction.
MergeBoldness The merge boldness. Defined from 0 to 1, low values will only merge deep cavities while high values will merge anything that falls under the merge distance.
MergeDistance The on-screen merge distance in pixels. Smaller cavities will be removed. This will be capped to the on-screen size of the remeshing.
Name The name of the RemeshingLegacySettings object. (Inherited from Object)
OnScreenSize The on-screen rendering size of the geometry. Allowed values are in the range 20 to 4000 pixels.
OutputSceneNodeName The name of the scene node in the output Scene containing the remeshed geometry.
ProcessSelectionSetID Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
ProcessSelectionSetName Which selection set should be processed. If the name 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.
RespectWindingDirection If true, the remeshing processor will not map backfacing triangles.
SurfaceTransferMode The surface transfer mode.
TransferColors If true, vertex color channels will be sampled from the original mesh.
TransferNormals If true, the vertex normals channel will be sampled from the original mesh.
UseClippingGeometry If true, the terrain selection set along with the terrain empty space override will be used to clip the remeshed geometry, like a clipping plane.
UseClippingGeometryEmptySpaceOverride If true, a coordinate in the area that will be considered "outside" for the clipping geometry can be overridden by the user.
UseCuttingPlanes Set to true to cap the mesh with user defined cutting planes.
UseEmptySpaceOverride If true, a coordinate in the area that will be considered "outside" can be overridden by the user, allowing the remesher to be used for things like interiors of caves and rooms.
UsePreviewMode If true, an alternate algorithm is used for the remeshing which is significantly faster, but supports smaller sizes ( up to 1000 OnScreenSize ), does not include any advanced features, and may be less precise.

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

# Properties details

# ClippingGeometryEmptySpaceOverride

The clipping geometry empty space override coordinate.

    # ClippingGeometrySelectionSetID

    The ID of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.

      # ClippingGeometrySelectionSetName

      The name of the selection set containing the terrain for clipping. If both selection set name and ID are set, the name will be used.

        # CuttingPlaneSelectionSetID

        The ID of the selection set containing all the cutting planes that should be used. If set to -1, all cutting planes are selected. Cutting planes will only be used if UseCuttingPlanes is true. If both selection set name and ID are set, the name will be used.

          # CuttingPlaneSelectionSetName

          The name of the selection set containing all the cutting planes that should be used. If the name is not found, all cutting planes are selected. If both selection set name and ID are set, the name will be used.

            # EmptySpaceOverride

            The empty space override coordinate.

              # HardEdgeAngle

              The normal hard angle cutoff in degrees.

                # MaxTriangleSize

                The maximum size in pixels of a generated triangle Any value from 5 pixels and above is allowed. If set to 0, there will be no restriction.

                  # MergeBoldness

                  The merge boldness. Defined from 0 to 1, low values will only merge deep cavities while high values will merge anything that falls under the merge distance.

                    # MergeDistance

                    The on-screen merge distance in pixels. Smaller cavities will be removed. This will be capped to the on-screen size of the remeshing.

                      # Name

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

                        # OnScreenSize

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

                          # OutputSceneNodeName

                          The name of the scene node in the output Scene containing the remeshed geometry.

                            # ProcessSelectionSetID

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

                              # ProcessSelectionSetName

                              Which selection set should be processed. If the name 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.

                                # RespectWindingDirection

                                If true, the remeshing processor will not map backfacing triangles.

                                  # SurfaceTransferMode

                                  The surface transfer mode.

                                    # TransferColors

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

                                      # TransferNormals

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

                                        # UseClippingGeometry

                                        If true, the terrain selection set along with the terrain empty space override will be used to clip the remeshed geometry, like a clipping plane.

                                          # UseClippingGeometryEmptySpaceOverride

                                          If true, a coordinate in the area that will be considered "outside" for the clipping geometry can be overridden by the user.

                                            # UseCuttingPlanes

                                            Set to true to cap the mesh with user defined cutting planes.

                                              # UseEmptySpaceOverride

                                              If true, a coordinate in the area that will be considered "outside" can be overridden by the user, allowing the remesher to be used for things like interiors of caves and rooms.

                                                # UsePreviewMode

                                                If true, an alternate algorithm is used for the remeshing which is significantly faster, but supports smaller sizes ( up to 1000 OnScreenSize ), does not include any advanced features, and may be less precise.

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

                                                                    # IsNull

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

                                                                      # IsSameObjectAs

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

                                                                        # NonNull

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

                                                                          # PrintInfo

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