Simplygon 10 Documentation

# 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. 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)
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

// Setter
void SetCompactMesh( bool value ) const;

// Getter
bool GetCompactMesh() const;

# SetCompactMesh parameters

Type Name Min Max Description
bool value 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

// Setter
void SetIgnoreVertexLocks( bool value ) const;

// Getter
bool GetIgnoreVertexLocks() const;

# SetIgnoreVertexLocks parameters

Type Name Min Max Description
bool value The desired flag value.

# GetIgnoreVertexLocks return value

Type: bool

Default: false

# Name

The name of the Welder object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type Name Min Max Description
const char * name New name of the object.

# GetName return value

Type: spString

# OnlyBetweenSceneNodes

If set, only vertices that belong to different scene nodes are considered for the welding.

# Syntax

// Setter
void SetOnlyBetweenSceneNodes( bool value ) const;

// Getter
bool GetOnlyBetweenSceneNodes() const;

# SetOnlyBetweenSceneNodes parameters

Type Name Min Max Description
bool value 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

// Setter
void SetOnlyBorders( bool value ) const;

// Getter
bool GetOnlyBorders() const;

# SetOnlyBorders parameters

Type Name Min Max Description
bool value 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

// Setter
void SetOnlyWithinMaterial( bool value ) const;

// Getter
bool GetOnlyWithinMaterial() const;

# SetOnlyWithinMaterial parameters

Type Name Min Max Description
bool value 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

// Setter
void SetOnlyWithinSceneNode( bool value ) const;

// Getter
bool GetOnlyWithinSceneNode() const;

# SetOnlyWithinSceneNode parameters

Type Name Min Max Description
bool value 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

// Setter
void SetProcessSelectionSetID( rid value ) const;

// Getter
rid GetProcessSelectionSetID() const;

# SetProcessSelectionSetID parameters

Type Name Min Max Description
rid value The ID of the selection set to use.

# GetProcessSelectionSetID return value

Type: rid

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

// Setter
void SetProcessSelectionSetName( const char * value ) const;

// Getter
spString GetProcessSelectionSetName() const;

# SetProcessSelectionSetName parameters

Type Name Min Max Description
const char * value The desired SelectionSet name.

# GetProcessSelectionSetName return value

Type: spString

# ProgressivePasses

The number of progressive passes.

# Syntax

// Setter
void SetProgressivePasses( unsigned int value ) const;

// Getter
unsigned int GetProgressivePasses() const;

# SetProgressivePasses parameters

Type Name Min Max Description
unsigned int value The number of passes to perform.

# GetProgressivePasses return value

Type: unsigned int

Default: 3

# Scene

The scene.

# Syntax

// Setter
void SetScene( const spScene & value ) const;

// Getter
spScene GetScene() const;

# SetScene parameters

Type Name Min Max Description
Scene value The scene object.

# GetScene return value

Type: Scene

# UpdateExtents

If true, the welder will call CalculateExtents on the geometry before welding.

# Syntax

// Setter
void SetUpdateExtents( bool value ) const;

// Getter
bool GetUpdateExtents() const;

# SetUpdateExtents parameters

Type Name Min Max Description
bool value The desired flag value.

# GetUpdateExtents return value

Type: bool

# WeldDist

The distance below which the vertices will be welded.

# Syntax

// Setter
void SetWeldDist( real value ) const;

// Getter
real GetWeldDist() const;

# SetWeldDist parameters

Type Name Min Max Description
real value The weld distance.

# GetWeldDist return value

Type: real

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

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type Name Min Max Description
Observer observer Observer is the object that will receive events.

# Return value

Type: rid

# Clear

Clear all internal states of the object. This will NOT clear the parameters set in the object.

# Syntax

void Clear() const;

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the Welder class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetPercentDone

Returns the current progress of the processing as a value between 0 and 100.

# Syntax

real GetPercentDone() const;

# Parameters

GetPercentDone takes no parameters.

# Return value

Type: real

# IsA

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

# Syntax

bool IsA( const char * type ) const;

# 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

# IsNull

Returns true if the Welder object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the Welder object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name 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

bool NonNull() const;

# 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

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId ObserverId is the id returned by AddObserver when the observer was added.

# 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.

# Syntax

Simplygon::EErrorCodes RunProcessing() const;

# Parameters

RunProcessing takes no parameters.

# Return value

Type: EErrorCodes

Key Value Comment
NoError 0 No error, the initialization or process has finished, and with no errors
NoLicense -1 no license was found (or licence expired)
NotInitialized -2 the SDK is not initialized, or no process object has been loaded/created
AlreadyInitialized -3 the SDK is already initialized
DLLOrDependenciesNotFound -4 the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment.
InvalidInputParam -5 an invalid parameter was passed to the method
FailedTesting -6 the reduction failed post-testing
DLLAndHeaderFileIsNotMatching -7 the Simplygon DLL and header file interface versions do not match
DLLFailedToLoad -8 the Simplygon DLL failed loading, probably because of a missing dependency
LicenseNotForThisApplication -9 the license is not made for this application of Simplygon
LicenseNotForThisPlatform -10 the license is not made for this platform of Simplygon
LicenseNotForThisVersion -11 the license is not made for this version of Simplygon
FailedToCreatePipelineSerializer -12 failed to create pipeline serializer
FailedToRunPipeline -13 failed to run pipeline
UnhandledException -14 an unhandled exception was encountered
FailedToUploadFreeLicenseAsset -50 failed to upload free license asset
ExceptionalError -1000 An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks.
FailedToResolveLicenseServerHostName -10001 cannot reach the licensing server, cant look up server, check DNS
FailedToConnectToLicenseServer -10002 cannot contact the licensing server, check firewall/proxy server
FailedToConnectToLicenseServerAndSendData -10003 Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy.
FailedToConnectToLicenseServerAndReceiveData -10004 cannot receive data from the licensing server, check firewall/proxy server
DataFromLicenseServerIsCorrupt -10005 data from licensing server is corrupted, try again, check connection
LicenseHasExpired -10006 the license has expired
LicenseIsInvalid -10007 the license data is corrupted, please reinstall the license key
LicenseNotForThisProduct -10008 the license is not for this product, please contact licensing, and replace license key
NoNetworkCardFound -10009 no network card was found on the machine
LicenseDecodeFailed -10010 could not decode license, it is corrupted
LicenseLockNotMatchingMachine -10011 the license is locked to another machine
ConnectionToLicenseServerLost -10012 Connection to license server lost
LicenseHashDataCorrupt -10013 could not decode license, it is corrupted
LicenseExpired -10014 the license is invalid, please contact licensing
LicenseNotLockedForThisMachine -10020 the license is locked to another machine
YourLicenseRequiresLatestWindows10 -10024 your license requires latest Windows 10 version
LicenseServerReturnedBadRequest -10400 Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
UnknownLicenseKey -10404 You are using an unknown license key. Please verify so you typed in the license key correctly and try again
LicenseIsNotActive -10410 You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support
MaxNodesReachForThisLicense -10409 You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine
YourLicenseRequiresLatestSimplygon -10426 The license key you are using requires you to update to the latest version before you can use Simplygon
LicenseServerReturnServerError -10501 Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
ProcessingValidationError -20001 The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes.

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON() const;

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

# WeldGeometry

Welds the geometry.

# Syntax

void WeldGeometry( const spGeometryData & geom ) const;

# Parameters

Type Name Min Max Description
GeometryData geom 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

static bool IsClassA( const char * type ) const;

# 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

# 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

static spWelder SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: Welder

←