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.
Syntax
SetClippingGeometryEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
RealData | value | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetClippingGeometryEmptySpaceOverride return value
Type: RealData
Default: 0.0,0.0,0.0
Syntax
SetClippingGeometryEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
float[] | value | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetClippingGeometryEmptySpaceOverride return value
Type: RealData
Default: 0.0,0.0,0.0
Syntax
SetClippingGeometryEmptySpaceOverride parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetClippingGeometryEmptySpaceOverride return value
Type: float
Default: 0.0,0.0,0.0
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.
Syntax
SetClippingGeometrySelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The ID of the selection set containing the clipping terrain. |
GetClippingGeometrySelectionSetID return value
Type: rid
Default: -1
Syntax
SetClippingGeometrySelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The ID of the selection set containing the clipping terrain. |
GetClippingGeometrySelectionSetID return value
Type: int
Default: -1
Syntax
SetClippingGeometrySelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The ID of the selection set containing the clipping terrain. |
GetClippingGeometrySelectionSetID return value
Type: int
Default: -1
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.
Syntax
SetClippingGeometrySelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetClippingGeometrySelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: string
Default: null
Syntax
SetClippingGeometrySelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetClippingGeometrySelectionSetName return value
Type: str
Default: None
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.
Syntax
SetCuttingPlaneSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The ID of the selection set containing the cutting planes. |
GetCuttingPlaneSelectionSetID return value
Type: rid
Default: -1
Syntax
SetCuttingPlaneSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The ID of the selection set containing the cutting planes. |
GetCuttingPlaneSelectionSetID return value
Type: int
Default: -1
Syntax
SetCuttingPlaneSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The ID of the selection set containing the cutting planes. |
GetCuttingPlaneSelectionSetID return value
Type: int
Default: -1
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.
Syntax
SetCuttingPlaneSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired SelectionSet name. |
GetCuttingPlaneSelectionSetName return value
Type: spString
Default: nullptr
Syntax
SetCuttingPlaneSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetCuttingPlaneSelectionSetName return value
Type: string
Default: null
Syntax
SetCuttingPlaneSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetCuttingPlaneSelectionSetName return value
Type: str
Default: None
EmptySpaceOverride
The empty space override coordinate.
Syntax
SetEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
RealData | value | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetEmptySpaceOverride return value
Type: RealData
Default: 0.0,0.0,0.0
Syntax
SetEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
float[] | value | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetEmptySpaceOverride return value
Type: RealData
Default: 0.0,0.0,0.0
Syntax
SetEmptySpaceOverride parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | Is a pointer to a 3-tuple real which will be copied and used as a marker designating empty space. |
GetEmptySpaceOverride return value
Type: float
Default: 0.0,0.0,0.0
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: 60
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: 60
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: 60
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.
Syntax
SetMaxTriangleSize parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The value MaxTriangleSize will be set to. |
GetMaxTriangleSize return value
Type: unsigned int
Default: 0
Syntax
SetMaxTriangleSize parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The value MaxTriangleSize will be set to. |
GetMaxTriangleSize return value
Type: uint
Default: 0
Syntax
SetMaxTriangleSize parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The value MaxTriangleSize will be set to. |
GetMaxTriangleSize return value
Type: int
Default: 0
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.
Syntax
SetMergeBoldness parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | 1 | The value MergeBoldness will be set to. |
GetMergeBoldness return value
Type: real
Default: 0.5
Syntax
SetMergeBoldness parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | 1 | The value MergeBoldness will be set to. |
GetMergeBoldness return value
Type: float
Default: 0.5
Syntax
SetMergeBoldness parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | 1 | The value MergeBoldness will be set to. |
GetMergeBoldness return value
Type: float
Default: 0.5
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.
Syntax
SetMergeDistance parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | 4000 | The value MergeDistance will be set to. |
GetMergeDistance return value
Type: unsigned int
Default: 4
Syntax
SetMergeDistance parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | 4000 | The value MergeDistance will be set to. |
GetMergeDistance return value
Type: uint
Default: 4
Syntax
SetMergeDistance parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | 4000 | The value MergeDistance will be set to. |
GetMergeDistance return value
Type: int
Default: 4
Name
The name of the RemeshingLegacySettings object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
OnScreenSize
The on-screen rendering size of the geometry. Allowed values are in the range 20 to 4000 pixels.
Syntax
SetOnScreenSize parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 20 | 4000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: unsigned int
Default: 100
Syntax
SetOnScreenSize parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 20 | 4000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: uint
Default: 100
Syntax
SetOnScreenSize parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 20 | 4000 | The value OnScreenSize will be set to. |
GetOnScreenSize return value
Type: int
Default: 100
OutputSceneNodeName
The name of the scene node in the output Scene containing the remeshed geometry.
Syntax
SetOutputSceneNodeName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired OutputSceneNodeName. |
GetOutputSceneNodeName return value
Type: spString
Default: nullptr
Syntax
SetOutputSceneNodeName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired OutputSceneNodeName. |
GetOutputSceneNodeName return value
Type: string
Default: null
Syntax
SetOutputSceneNodeName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired OutputSceneNodeName. |
GetOutputSceneNodeName return value
Type: str
Default: None
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 |
|---|
int | value | -1 | | The desired SelectionSet id. |
GetProcessSelectionSetID return value
Type: int
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
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.
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
RespectWindingDirection
If true, the remeshing processor will not map backfacing triangles.
Syntax
SetRespectWindingDirection parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of RespectWindingDirection. |
GetRespectWindingDirection return value
Type: bool
Default: false
Syntax
SetRespectWindingDirection parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of RespectWindingDirection. |
GetRespectWindingDirection return value
Type: bool
Default: false
Syntax
SetRespectWindingDirection parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired value of RespectWindingDirection. |
GetRespectWindingDirection return value
Type: bool
Default: false
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: 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: ESurfaceTransferMode
Default: Accurate
| Key | Value | Comment |
|---|
| ESurfaceTransferMode_Fast | 0 | Faster but with less precise calculations. |
| ESurfaceTransferMode_Accurate | 1 | Slower and more accurate. |
TransferColors
If true, 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 true, 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
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.
Syntax
SetUseClippingGeometry parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseClippingGeometry will be set. |
GetUseClippingGeometry return value
Type: bool
Default: false
Syntax
SetUseClippingGeometry parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool to which UseClippingGeometry will be set. |
GetUseClippingGeometry return value
Type: bool
Default: false
Syntax
SetUseClippingGeometry parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool to which UseClippingGeometry will be set. |
GetUseClippingGeometry return value
Type: bool
Default: false
UseClippingGeometryEmptySpaceOverride
If true, a coordinate in the area that will be considered "outside" for the clipping geometry can be overridden by the user.
Syntax
SetUseClippingGeometryEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UseClippingGeometryEmptySpaceOverride will be set. |
GetUseClippingGeometryEmptySpaceOverride return value
Type: bool
Default: false
Syntax
SetUseClippingGeometryEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UseClippingGeometryEmptySpaceOverride will be set. |
GetUseClippingGeometryEmptySpaceOverride return value
Type: bool
Default: false
Syntax
SetUseClippingGeometryEmptySpaceOverride parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which UseClippingGeometryEmptySpaceOverride will be set. |
GetUseClippingGeometryEmptySpaceOverride return value
Type: bool
Default: false
UseCuttingPlanes
Set to true to cap the mesh with user defined cutting planes.
Syntax
SetUseCuttingPlanes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool UseCuttingPlanes will be set to. |
GetUseCuttingPlanes return value
Type: bool
Default: false
Syntax
SetUseCuttingPlanes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The bool UseCuttingPlanes will be set to. |
GetUseCuttingPlanes return value
Type: bool
Default: false
Syntax
SetUseCuttingPlanes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The bool UseCuttingPlanes will be set to. |
GetUseCuttingPlanes return value
Type: bool
Default: false
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.
Syntax
SetUseEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UseEmptySpaceOverride will be set. |
GetUseEmptySpaceOverride return value
Type: bool
Default: false
Syntax
SetUseEmptySpaceOverride parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UseEmptySpaceOverride will be set. |
GetUseEmptySpaceOverride return value
Type: bool
Default: false
Syntax
SetUseEmptySpaceOverride parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which UseEmptySpaceOverride will be set. |
GetUseEmptySpaceOverride return value
Type: bool
Default: false
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.
Syntax
SetUsePreviewMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UsePreviewMode will be set. |
GetUsePreviewMode return value
Type: bool
Default: false
Syntax
SetUsePreviewMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which UsePreviewMode will be set. |
GetUsePreviewMode return value
Type: bool
Default: false
Syntax
SetUsePreviewMode parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which UsePreviewMode will be set. |
GetUsePreviewMode return value
Type: bool
Default: false
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
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 RemeshingLegacySettings class. (Inherited from Object)
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 RemeshingLegacySettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if RemeshingLegacySettings 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 RemeshingLegacySettings 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 RemeshingLegacySettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the RemeshingLegacySettings object is invalid. (Inherited from Object)
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
IsSameObjectAs
Returns true if the RemeshingLegacySettings object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the RemeshingLegacySettings object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the RemeshingLegacySettings object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
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. (Inherited from Object)
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 spRemeshingLegacySettings, and if this is the case, returns the object cast into spRemeshingLegacySettings. (Inherited from Object)
