class RepairSettings
Settings for handling unconnected parts and unwanted gaps in the geometry. It consists of two parts, Welding and T-junction removal. Welding merges vertices that are closer than a set distance from each other. T-junction removal finds open edges that lies within a set distance from other open edges, but without matching vertices. It then splits those triangles into smaller, matching triangles and fuses them together.
Properties
| Property | Description |
|---|
| ProgressivePasses | The number of progressive passes. Minimum is 1, but higher numbers give a better quality, at the expense of longer running time. |
| TJuncDist | The T-Junction distance, below which, the T-Junctions will be welded. |
| UseTJunctionRemover | If set, t-junctions will be removed. If enabled, it also requires UseWelding to be on. |
| UseWelding | If set, vertices within each others welding distance will be welded together. |
| WeldDist | The welding distance below which the vertices will be welded. |
| WeldOnlyBetweenSceneNodes | If set, only vertices that belong to different scene nodes are considered for the welding. Affects both welder and t-junction remover. |
| WeldOnlyBorderVertices | If set, only vertices that are on the border (as reported by the VertexBorder boolean field) are considered for the welding. |
| WeldOnlyWithinMaterial | If set, only vertices that are within the same material are welded. Vertices on material borders are locked. |
| WeldOnlyWithinSceneNode | If set, only vertices that are within the same scene node are welded. |
Methods
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 spRepairSettings, and if this is the case, returns the object cast into spRepairSettings. |
Properties details
ProgressivePasses
The number of progressive passes. Minimum is 1, but higher numbers give a better quality, at the expense of longer running time.
Syntax
SetProgressivePasses parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 1 | 10 | The integer to which ProgressivePasses will be set. |
GetProgressivePasses return value
Type: unsigned int
Default: 3
Syntax
SetProgressivePasses parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 1 | 10 | The integer to which ProgressivePasses will be set. |
GetProgressivePasses return value
Type: uint
Default: 3
Syntax
SetProgressivePasses parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 1 | 10 | The integer to which ProgressivePasses will be set. |
GetProgressivePasses return value
Type: int
Default: 3
TJuncDist
The T-Junction distance, below which, the T-Junctions will be welded.
Syntax
SetTJuncDist parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | REAL_MAX | The value to which TJuncDist will be set. |
GetTJuncDist return value
Type: real
Default: 0.0
Syntax
SetTJuncDist parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | REAL_MAX | The value to which TJuncDist will be set. |
GetTJuncDist return value
Type: float
Default: 0.0
Syntax
SetTJuncDist parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | REAL_MAX | The value to which TJuncDist will be set. |
GetTJuncDist return value
Type: float
Default: 0.0
UseTJunctionRemover
If set, t-junctions will be removed. If enabled, it also requires UseWelding to be on.
Syntax
SetUseTJunctionRemover parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseTJunctionRemover will be set. |
GetUseTJunctionRemover return value
Type: bool
Default: true
Syntax
SetUseTJunctionRemover parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseTJunctionRemover will be set. |
GetUseTJunctionRemover return value
Type: bool
Default: true
Syntax
SetUseTJunctionRemover parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which UseTJunctionRemover will be set. |
GetUseTJunctionRemover return value
Type: bool
Default: true
UseWelding
If set, vertices within each others welding distance will be welded together.
Syntax
SetUseWelding parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseWelding will be set. |
GetUseWelding return value
Type: bool
Default: true
Syntax
SetUseWelding parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseWelding will be set. |
GetUseWelding return value
Type: bool
Default: true
Syntax
SetUseWelding parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which UseWelding will be set. |
GetUseWelding return value
Type: bool
Default: true
WeldDist
The welding distance below which the vertices will be welded.
Syntax
SetWeldDist parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | REAL_MAX | The value to which WeldDist will be set. |
GetWeldDist return value
Type: real
Default: 0.0
Syntax
SetWeldDist parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | REAL_MAX | The value to which WeldDist will be set. |
GetWeldDist return value
Type: float
Default: 0.0
Syntax
SetWeldDist parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | REAL_MAX | The value to which WeldDist will be set. |
GetWeldDist return value
Type: float
Default: 0.0
WeldOnlyBetweenSceneNodes
If set, only vertices that belong to different scene nodes are considered for the welding. Affects both welder and t-junction remover.
Syntax
SetWeldOnlyBetweenSceneNodes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyBetweenSceneNode will be set. |
GetWeldOnlyBetweenSceneNodes return value
Type: bool
Default: false
Syntax
SetWeldOnlyBetweenSceneNodes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyBetweenSceneNode will be set. |
GetWeldOnlyBetweenSceneNodes return value
Type: bool
Default: false
Syntax
SetWeldOnlyBetweenSceneNodes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which WeldOnlyBetweenSceneNode will be set. |
GetWeldOnlyBetweenSceneNodes return value
Type: bool
Default: false
WeldOnlyBorderVertices
If set, only vertices that are on the border (as reported by the VertexBorder boolean field) are considered for the welding.
Syntax
SetWeldOnlyBorderVertices parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyBorderVertices will be set. |
GetWeldOnlyBorderVertices return value
Type: bool
Default: false
Syntax
SetWeldOnlyBorderVertices parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyBorderVertices will be set. |
GetWeldOnlyBorderVertices return value
Type: bool
Default: false
Syntax
SetWeldOnlyBorderVertices parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which WeldOnlyBorderVertices will be set. |
GetWeldOnlyBorderVertices return value
Type: bool
Default: false
WeldOnlyWithinMaterial
If set, only vertices that are within the same material are welded. Vertices on material borders are locked.
Syntax
SetWeldOnlyWithinMaterial parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyWithinMaterial will be set. |
GetWeldOnlyWithinMaterial return value
Type: bool
Default: false
Syntax
SetWeldOnlyWithinMaterial parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyWithinMaterial will be set. |
GetWeldOnlyWithinMaterial return value
Type: bool
Default: false
Syntax
SetWeldOnlyWithinMaterial parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which WeldOnlyWithinMaterial will be set. |
GetWeldOnlyWithinMaterial return value
Type: bool
Default: false
WeldOnlyWithinSceneNode
If set, only vertices that are within the same scene node are welded.
Syntax
SetWeldOnlyWithinSceneNode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyWithinSceneNode will be set. |
GetWeldOnlyWithinSceneNode return value
Type: bool
Default: false
Syntax
SetWeldOnlyWithinSceneNode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which WeldOnlyWithinSceneNode will be set. |
GetWeldOnlyWithinSceneNode return value
Type: bool
Default: false
Syntax
SetWeldOnlyWithinSceneNode parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which WeldOnlyWithinSceneNode will be set. |
GetWeldOnlyWithinSceneNode 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 RepairSettings 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 RepairSettings 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 RepairSettings 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 RepairSettings 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 RepairSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the RepairSettings 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
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 spRepairSettings, and if this is the case, returns the object cast into spRepairSettings.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: RepairSettings
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: RepairSettings
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: RepairSettings
