Skip to content
On this page

class Welder ​

Welds vertices within the geometry or scene together.

Properties ​

PropertyDescription
CompactMeshIf true, the welder will call Compact on the geometry after welding.
IgnoreVertexLocksIf IgnoreVertexLocks is true, then also vertices that are locked may be welded.
NameThe name of the Welder object. (Inherited from Object)
OnlyBetweenSceneNodesIf set, only vertices that belong to different scene nodes are considered for the welding.
OnlyBordersIf set, only vertices that are on the border are considered for the welding.
OnlyWithinMaterialIf set, only vertices that are within the same material are welded. Vertices on material borders are locked.
OnlyWithinSceneNodeIf set, only vertices that are within the same scene node are welded.
ProcessSelectionSetIDThe 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.
ProcessSelectionSetNameThe 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.
ProgressivePassesThe number of progressive passes.
SceneThe scene.
UpdateExtentsIf true, the welder will call CalculateExtents on the geometry before welding.
WeldDistThe distance below which the vertices will be welded.

Methods ​

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
ClearClear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject)
GetClassGet the name of the Welder class. (Inherited from Object)
GetPercentDoneReturns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
IsAReturns true if Welder is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the Welder object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the Welder object is valid. (Inherited from Object)
NonNullReturns true if the Welder object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the Welder object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunProcessingRuns the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject)
ToJSONGet settings as JSON for debugging purposes. (Inherited from ProcessingObject)
WeldGeometryWelds the geometry.

Static methods ​

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into 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.

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 details ​

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.

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.

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. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.

ToJSON ​

Get settings as JSON for debugging purposes.

WeldGeometry ​

Welds the geometry.

Static methods details ​

IsClassA ​

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

SafeCast ​

SafeCast makes sure the input object is of a class that can be cast into spWelder, and if this is the case, returns the object cast into spWelder. (Inherited from Object)