class Welder
Welds vertices within the geometry or scene together.
Properties
| Property | Description |
|---|
| CompactMesh | If true, the welder will call Compact on the geometry after welding. |
| IgnoreVertexLocks | If IgnoreVertexLocks is true, then also vertices that are locked may be welded. |
| Name | The name of the Welder object. (Inherited from Object) |
| OnlyBetweenSceneNodes | If set, only vertices that belong to different scene nodes are considered for the welding. |
| OnlyBorders | If set, only vertices that are on the border are considered for the welding. |
| OnlyWithinMaterial | If set, only vertices that are within the same material are welded. Vertices on material borders are locked. |
| OnlyWithinSceneNode | If set, only vertices that are within the same scene node are welded. |
| ProcessSelectionSetID | The ID of the selection set containing the meshes to weld If the ID is -1, all meshes are selected. If both selection set name and ID are set, the name will be used. |
| ProcessSelectionSetName | The now of the selection set containing the meshes to weld. 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. |
| ProgressivePasses | The number of progressive passes. |
| Scene | The scene. |
| UpdateExtents | If true, the welder will call CalculateExtents on the geometry before welding. |
| WeldDist | The distance below which the vertices will be welded. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Clear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject) |
| GetClass | Get the name of the Welder class. (Inherited from Object) |
| GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject) |
| IsA | Returns true if Welder is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the Welder object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the Welder object is valid. (Inherited from Object) |
| NonNull | Returns true if the Welder object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the Welder object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunProcessing | Runs the processing the object is designed for. (Inherited from ProcessingObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from ProcessingObject) |
| WeldGeometry | Welds the geometry. |
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 spWelder, and if this is the case, returns the object cast into spWelder. (Inherited from Object) |
Properties details
CompactMesh
If true, the welder will call Compact on the geometry after welding.
Syntax
SetCompactMesh parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCompactMesh return value
Type: bool
Default: true
Syntax
SetCompactMesh parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetCompactMesh return value
Type: bool
Default: true
Syntax
SetCompactMesh parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetCompactMesh return value
Type: bool
Default: true
IgnoreVertexLocks
If IgnoreVertexLocks is true, then also vertices that are locked may be welded.
Syntax
SetIgnoreVertexLocks parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetIgnoreVertexLocks return value
Type: bool
Default: false
Syntax
SetIgnoreVertexLocks parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetIgnoreVertexLocks return value
Type: bool
Default: false
Syntax
SetIgnoreVertexLocks parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetIgnoreVertexLocks return value
Type: bool
Default: false
Name
The name of the Welder 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
OnlyBetweenSceneNodes
If set, only vertices that belong to different scene nodes are considered for the welding.
Syntax
SetOnlyBetweenSceneNodes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyBetweenSceneNodes return value
Type: bool
Default: false
Syntax
SetOnlyBetweenSceneNodes parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyBetweenSceneNodes return value
Type: bool
Default: false
Syntax
SetOnlyBetweenSceneNodes parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetOnlyBetweenSceneNodes return value
Type: bool
Default: false
OnlyBorders
If set, only vertices that are on the border are considered for the welding.
Syntax
SetOnlyBorders parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new OnlyBorders value. |
GetOnlyBorders return value
Type: bool
Default: false
Syntax
SetOnlyBorders parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new OnlyBorders value. |
GetOnlyBorders return value
Type: bool
Default: false
Syntax
SetOnlyBorders parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new OnlyBorders value. |
GetOnlyBorders return value
Type: bool
Default: false
OnlyWithinMaterial
If set, only vertices that are within the same material are welded. Vertices on material borders are locked.
Syntax
SetOnlyWithinMaterial parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyWithinMaterial return value
Type: bool
Default: false
Syntax
SetOnlyWithinMaterial parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyWithinMaterial return value
Type: bool
Default: false
Syntax
SetOnlyWithinMaterial parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetOnlyWithinMaterial return value
Type: bool
Default: false
OnlyWithinSceneNode
If set, only vertices that are within the same scene node are welded.
Syntax
SetOnlyWithinSceneNode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyWithinSceneNode return value
Type: bool
Default: false
Syntax
SetOnlyWithinSceneNode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetOnlyWithinSceneNode return value
Type: bool
Default: false
Syntax
SetOnlyWithinSceneNode parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetOnlyWithinSceneNode return value
Type: bool
Default: false
ProcessSelectionSetID
The ID of the selection set containing the meshes to weld If the ID is -1, all meshes are selected. If both selection set name and ID are set, the name will be used.
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | The ID of the selection set to use. |
GetProcessSelectionSetID return value
Type: rid
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The ID of the selection set to use. |
GetProcessSelectionSetID return value
Type: int
Default: -1
Syntax
SetProcessSelectionSetID parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The ID of the selection set to use. |
GetProcessSelectionSetID return value
Type: int
Default: -1
ProcessSelectionSetName
The now of the selection set containing the meshes to weld. 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
Syntax
SetProcessSelectionSetName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: string
Syntax
SetProcessSelectionSetName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired SelectionSet name. |
GetProcessSelectionSetName return value
Type: str
ProgressivePasses
The number of progressive passes.
Syntax
SetProgressivePasses parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | | | The number of passes to perform. |
GetProgressivePasses return value
Type: unsigned int
Default: 3
Syntax
SetProgressivePasses parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | | | The number of passes to perform. |
GetProgressivePasses return value
Type: uint
Default: 3
Syntax
SetProgressivePasses parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The number of passes to perform. |
GetProgressivePasses return value
Type: int
Default: 3
Scene
The scene.
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene object. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The scene object. |
GetScene return value
Type: Scene
Syntax
SetScene parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | The scene object. |
GetScene return value
Type: Scene
UpdateExtents
If true, the welder will call CalculateExtents on the geometry before welding.
Syntax
SetUpdateExtents parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUpdateExtents return value
Type: bool
Syntax
SetUpdateExtents parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUpdateExtents return value
Type: bool
Syntax
SetUpdateExtents parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetUpdateExtents return value
Type: bool
WeldDist
The distance below which the vertices will be welded.
Syntax
SetWeldDist parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The weld distance. |
GetWeldDist return value
Type: real
Default: 0
Syntax
SetWeldDist parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The weld distance. |
GetWeldDist return value
Type: float
Default: 0
Syntax
SetWeldDist parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The weld distance. |
GetWeldDist return value
Type: float
Default: 0
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
Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the Welder 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
GetPercentDone
Returns the current progress of the processing as a value between 0 and 100.
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: real
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
IsA
Returns true if Welder 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 Welder 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 Welder 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 Welder is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the Welder 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 Welder 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 Welder 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 Welder 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. |
RunProcessing
Runs the processing the object is designed for.
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| EProcessStatus_Finished | 0 | The process finished with no error |
| EProcessStatus_Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
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
WeldGeometry
Welds the geometry.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry data object. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry data object. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geom | GeometryData | | | The geometry data object. |
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 spWelder, and if this is the case, returns the object cast into spWelder. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: Welder
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: Welder
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: Welder
