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.
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | 180 | The value to which HardEdgeAngle will be set. |
GetHardEdgeAngle return value
Type: real
Default: 75
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | 180 | The value to which HardEdgeAngle will be set. |
GetHardEdgeAngle return value
Type: float
Default: 75
Syntax
SetHardEdgeAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | 180 | The value to which HardEdgeAngle will be set. |
GetHardEdgeAngle return value
Type: float
Default: 75
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.
Syntax
SetHoleFilling parameters
| Type | Name | Min | Max | Description |
|---|
| EHoleFilling | value | | | The new hole fill mode. |
GetHoleFilling return value
Type: EHoleFilling
Default: Low
| Key | Value | Comment |
|---|
| Disabled | 0 | No hole filling. |
| Low | 1 | Minor hole filling. |
| Medium | 2 | Moderate ammounts of hole filling. |
| High | 3 | Aggresive hole filling. |
Syntax
SetHoleFilling parameters
| Type | Name | Min | Max | Description |
|---|
| EHoleFilling | value | | | The new hole fill mode. |
GetHoleFilling return value
Type: ``````
Default: Low
| Key | Value | Comment |
|---|
| Disabled | 0 | No hole filling. |
| Low | 1 | Minor hole filling. |
| Medium | 2 | Moderate ammounts of hole filling. |
| High | 3 | Aggresive hole filling. |
Syntax
SetHoleFilling parameters
| Name | Type | Min | Max | Description |
|---|
| value | EHoleFilling | | | The new hole fill mode. |
GetHoleFilling return value
Type: EHoleFilling
Default: Low
| Key | Value | Comment |
|---|
| EHoleFilling_Disabled | 0 | No hole filling. |
| EHoleFilling_Low | 1 | Minor hole filling. |
| EHoleFilling_Medium | 2 | Moderate ammounts of hole filling. |
| EHoleFilling_High | 3 | Aggresive hole filling. |
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.
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
Syntax
SetKeepUnprocessedSceneMeshes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired KeepUnprocessedSceneMeshes flag. |
GetKeepUnprocessedSceneMeshes return value
Type: bool
Default: false
OnScreenSize
The on-screen rendering size of the geometry. Allowed values are in the range 20 to 10000 pixels.
Syntax
SetOnScreenSize parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 20 | 10000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: unsigned int
Default: 300
Syntax
SetOnScreenSize parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 20 | 10000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: uint
Default: 300
Syntax
SetOnScreenSize parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 20 | 10000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: int
Default: 300
ProcessSelectionSetID
Selects which SelectionSet should be processed. If set to -1, all geometries in the scene will be processed.
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: rid
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: rid
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: int
Default: -1
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.
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: string
Default: null
Syntax
SetProcessSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: str
Default: None
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.
Syntax
SetRemeshingMode parameters
| Type | Name | Min | Max | Description |
|---|
| ERemeshingMode | value | | | The new remeshing mode. |
GetRemeshingMode return value
Type: ERemeshingMode
Default: Outside
| Key | Value | Comment |
|---|
| Outside | 0 | Automatically remeshes the outside of the geometry. |
| Inside | 1 | Automatically remeshes the largest inside space of the geometry |
| Manual | 2 | User defines a position in space that will be considered as outside for the purposes of the remeshing. These position values can be set via global settings (RemeshingModeManualPositionX/Y/Z). If global settings are not set, this will fallback to ERemeshingMode::Outside. |
Syntax
SetRemeshingMode parameters
| Type | Name | Min | Max | Description |
|---|
| ERemeshingMode | value | | | The new remeshing mode. |
GetRemeshingMode return value
Type: ``````
Default: Outside
| Key | Value | Comment |
|---|
| Outside | 0 | Automatically remeshes the outside of the geometry. |
| Inside | 1 | Automatically remeshes the largest inside space of the geometry |
| Manual | 2 | User defines a position in space that will be considered as outside for the purposes of the remeshing. These position values can be set via global settings (RemeshingModeManualPositionX/Y/Z). If global settings are not set, this will fallback to ERemeshingMode::Outside. |
Syntax
SetRemeshingMode parameters
| Name | Type | Min | Max | Description |
|---|
| value | ERemeshingMode | | | The new remeshing mode. |
GetRemeshingMode return value
Type: ERemeshingMode
Default: Outside
| Key | Value | Comment |
|---|
| ERemeshingMode_Outside | 0 | Automatically remeshes the outside of the geometry. |
| ERemeshingMode_Inside | 1 | Automatically remeshes the largest inside space of the geometry |
| ERemeshingMode_Manual | 2 | User defines a position in space that will be considered as outside for the purposes of the remeshing. These position values can be set via global settings (RemeshingModeManualPositionX/Y/Z). If global settings are not set, this will fallback to ERemeshingMode::Outside. |
SurfaceTransferMode
The surface transfer mode.
Syntax
SetSurfaceTransferMode parameters
GetSurfaceTransferMode return value
Type: ESurfaceTransferMode
Default: Accurate
| Key | Value | Comment |
|---|
| Fast | 0 | Faster but with less precise calculations. |
| Accurate | 1 | Slower and more accurate. |
Syntax
SetSurfaceTransferMode parameters
GetSurfaceTransferMode return value
Type: ``````
Default: Accurate
| Key | Value | Comment |
|---|
| Fast | 0 | Faster but with less precise calculations. |
| Accurate | 1 | Slower and more accurate. |
Syntax
SetSurfaceTransferMode parameters
GetSurfaceTransferMode return value
Type: ESurfaceTransferMode
Default: Accurate
| Key | Value | Comment |
|---|
| ESurfaceTransferMode_Fast | 0 | Faster but with less precise calculations. |
| ESurfaceTransferMode_Accurate | 1 | Slower and more accurate. |
TransferColors
If set, vertex color channels will be sampled from the original mesh.
Syntax
SetTransferColors parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which TransferColors will be set. |
GetTransferColors return value
Type: bool
Default: false
Syntax
SetTransferColors parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which TransferColors will be set. |
GetTransferColors return value
Type: bool
Default: false
Syntax
SetTransferColors parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which TransferColors will be set. |
GetTransferColors return value
Type: bool
Default: false
TransferNormals
If set, the vertex normals channel will be sampled from the original mesh.
Syntax
SetTransferNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which TransferNormals will be set. |
GetTransferNormals return value
Type: bool
Default: false
Syntax
SetTransferNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which TransferNormals will be set. |
GetTransferNormals return value
Type: bool
Default: false
Syntax
SetTransferNormals parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which TransferNormals will be set. |
GetTransferNormals return value
Type: bool
Default: false
Methods details
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the RemeshingSettings class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if RemeshingSettings is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if RemeshingSettings is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if RemeshingSettings is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if RemeshingSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the RemeshingSettings object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: RemeshingSettings
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: RemeshingSettings
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: RemeshingSettings
