Simplygon 9 Documentation

# 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.
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
GetClass Get the name of the RemeshingLegacySettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
IsA Returns true if RemeshingLegacySettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the RemeshingLegacySettings object is invalid.
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 spRemeshingLegacySettings, and if this is the case, returns the object cast into spRemeshingLegacySettings.

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

                      # 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

                                                # GetClass

                                                Get the name of the RemeshingLegacySettings class.

                                                  # GetErrorString

                                                  Returns a string describing the error that was found the last time ValidateSettings was performed.

                                                    # IsA

                                                    Returns true if RemeshingLegacySettings is a or is a descendant of the class named as the type parameter.

                                                      # IsNull

                                                      Returns true if the RemeshingLegacySettings object is invalid.

                                                        # 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 spRemeshingLegacySettings, and if this is the case, returns the object cast into spRemeshingLegacySettings.

                                                              ← RemeshingSettings →