Skip to content
On this page

class RemeshingSettings

Remeshing settings for the RemeshingProcessor class.

Properties

PropertyDescription
ForceSoftEdgesWithinTextureChartsIf the flag is set, the normal calculation will only allow hard edges along texture borders. Any vertex normal within a texture chart (not along the border) will be forced soft. Caveat: If this is enabled, some normals might be highly interpolated, and deviate substantially from the triangle normal.
GeometricalAccuracySet the relative geometrical accuracy of the output mesh. A value less than 1 will lower the accuracy, and lower the output triangle count, but might introduce intersections in the output geometry. A value above 1 will introduce more triangles, and will be able to capture the input geometry more accurately in the output.
HardEdgeAngleThe normal hard angle cutoff in degrees.
HoleFillingHoleFilling defines how aggressively 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 unnecessary 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.
KeepUnprocessedSceneMeshesIf 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.
LimitMaxEdgeLengthThe LimitMaxEdgeLength flag. If set, the remesher will limit the maximum edge length of the generated triangles to the size specified in MaxEdgeLength.
MaxDerivedOnScreenSizeWhen using RemeshingTarget 'MaxDeviation', the upper limit of the internal 'OnScreenSize' derived from 'MaxDeviation' and the scene size. Allowed values are in the range 20 to 10000 pixels.
MaxDeviationWhen using RemeshingTarget 'MaxDeviation', the geometry generation resolution described as maximum deviation in absolute scene units. Allowed values between 0 and 'REAL_MAX'. Also make sure to set MaxDerivedOnScreenSize.
MaxEdgeLengthLimits the allowed size of the triangles in the output mesh, allowing generation of more uniform triangle distribution and tesselation across flat planes. The unit of this limit is the same as the currently active RemeshingTarget, i.e. it is in pixels on-screen when using OnScreenSize, and in absolute scene units when using MaxDeviation. Setting this value to 0 disables the feature.
NameThe name of the RemeshingSettings object. (Inherited from Object)
OnScreenSizeWhen using RemeshingTarget 'OnScreenSize', the geometry generation resolution described as on-screen pixel size of the input scene. Allowed values are in the range 20 to 10000 pixels.
PopulateAttributeTessellationDisplacementIf set, the AttributeTessellation geometry fields on the output mesh, as defined by the AttributeTessellationSettings on the RemeshingProcessor, will be populated with the sub-vertices actual displacement to the original input mesh. This displacement can then be applied to the geometry as a post process, or it can be exported along with the base mesh as micromesh data.
ProcessSelectionSetIDSelects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
ProcessSelectionSetNameSelects 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.
RemeshingModeThe 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.
RemeshingModeManualPositionXX component was a 3-tuple real that acts as the marker designating remeshing processors starting position
RemeshingModeManualPositionYY component was a 3-tuple real that acts as the marker designating remeshing processors starting position
RemeshingModeManualPositionZZ component was a 3-tuple real that acts as the marker designating remeshing processors starting position
RemeshingTargetThe remeshing target, options are 'OnScreenSize' and 'MaxDeviation'. 'OnScreenSize' sets the resolution of the geometry generation based on the input geometry size at a specific pixel size on screen, while 'MaxDeviation' is expressed in absolute scene distance, allowing consistent level of detail across inputs with different sizes. When using target type 'OnScreenSize', only the uint setting 'OnScreenSize' needs to be set. When using target type 'MaxDeviation', both 'MaxDeviation' and 'MaxDerivedOnscreenSize' needs to be set. The 'MaxDeviation' target works by converting the 'MaxDeviation' setting value to an implicit internal 'OnScreenSize'. Since this derived internal 'OnScreenSize' approaches infinity as 'MaxDeviation' approaches 0, it is limited using the 'MaxDerivedOnscreenSize' setting. Because of this behavior, very low 'MaxDeviation' settings can cause output meshes to have more triangles than the input meshes, so make sure the 'MaxDeviation' is set to reasonable values in the context of the input geometry to ensure good results.
SurfaceTransferModeThe surface transfer mode.
TopologicalAccuracySet the topological accuracy of the output mesh. 1=default accuracy, 0=minimal topological accuracy. Lowering the accuracy will lower the memory requirements, and increase remeshing performance, at the cost of lower topological accuracy, where the remesher fills in larger gaps or holes.
TransferColorsIf set, vertex color channels will be sampled from the original mesh.
TransferNormalsIf set, the vertex normals channel will be sampled from the original mesh.

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

Properties details

ForceSoftEdgesWithinTextureCharts

If the flag is set, the normal calculation will only allow hard edges along texture borders. Any vertex normal within a texture chart (not along the border) will be forced soft. Caveat: If this is enabled, some normals might be highly interpolated, and deviate substantially from the triangle normal.

GeometricalAccuracy

Set the relative geometrical accuracy of the output mesh. A value less than 1 will lower the accuracy, and lower the output triangle count, but might introduce intersections in the output geometry. A value above 1 will introduce more triangles, and will be able to capture the input geometry more accurately in the output.

HardEdgeAngle

The normal hard angle cutoff in degrees.

HoleFilling

HoleFilling defines how aggressively 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 unnecessary 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.

LimitMaxEdgeLength

The LimitMaxEdgeLength flag. If set, the remesher will limit the maximum edge length of the generated triangles to the size specified in MaxEdgeLength.

MaxDerivedOnScreenSize

When using RemeshingTarget 'MaxDeviation', the upper limit of the internal 'OnScreenSize' derived from 'MaxDeviation' and the scene size. Allowed values are in the range 20 to 10000 pixels.

MaxDeviation

When using RemeshingTarget 'MaxDeviation', the geometry generation resolution described as maximum deviation in absolute scene units. Allowed values between 0 and 'REAL_MAX'. Also make sure to set MaxDerivedOnScreenSize.

MaxEdgeLength

Limits the allowed size of the triangles in the output mesh, allowing generation of more uniform triangle distribution and tesselation across flat planes. The unit of this limit is the same as the currently active RemeshingTarget, i.e. it is in pixels on-screen when using OnScreenSize, and in absolute scene units when using MaxDeviation. Setting this value to 0 disables the feature.

Name

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

OnScreenSize

When using RemeshingTarget 'OnScreenSize', the geometry generation resolution described as on-screen pixel size of the input scene. Allowed values are in the range 20 to 10000 pixels.

PopulateAttributeTessellationDisplacement

If set, the AttributeTessellation geometry fields on the output mesh, as defined by the AttributeTessellationSettings on the RemeshingProcessor, will be populated with the sub-vertices actual displacement to the original input mesh. This displacement can then be applied to the geometry as a post process, or it can be exported along with the base mesh as micromesh data.

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.

RemeshingModeManualPositionX

X component was a 3-tuple real that acts as the marker designating remeshing processors starting position

RemeshingModeManualPositionY

Y component was a 3-tuple real that acts as the marker designating remeshing processors starting position

RemeshingModeManualPositionZ

Z component was a 3-tuple real that acts as the marker designating remeshing processors starting position

RemeshingTarget

The remeshing target, options are 'OnScreenSize' and 'MaxDeviation'. 'OnScreenSize' sets the resolution of the geometry generation based on the input geometry size at a specific pixel size on screen, while 'MaxDeviation' is expressed in absolute scene distance, allowing consistent level of detail across inputs with different sizes. When using target type 'OnScreenSize', only the uint setting 'OnScreenSize' needs to be set. When using target type 'MaxDeviation', both 'MaxDeviation' and 'MaxDerivedOnscreenSize' needs to be set. The 'MaxDeviation' target works by converting the 'MaxDeviation' setting value to an implicit internal 'OnScreenSize'. Since this derived internal 'OnScreenSize' approaches infinity as 'MaxDeviation' approaches 0, it is limited using the 'MaxDerivedOnscreenSize' setting. Because of this behavior, very low 'MaxDeviation' settings can cause output meshes to have more triangles than the input meshes, so make sure the 'MaxDeviation' is set to reasonable values in the context of the input geometry to ensure good results.

SurfaceTransferMode

The surface transfer mode.

TopologicalAccuracy

Set the topological accuracy of the output mesh. 1=default accuracy, 0=minimal topological accuracy. Lowering the accuracy will lower the memory requirements, and increase remeshing performance, at the cost of lower topological accuracy, where the remesher fills in larger gaps or holes.

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

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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