Skip to content
On this page

class ModularSeamAnalyzer

Properties

PropertyDescription
IsTranslationIndependentIf the modular seams are translation independent the assets don't have to align position wise next to each other. The modular seam will be identical even if the asset has been translated. This setting can only be changed before geometries have been added to the analyzer.
NameThe name of the ModularSeamAnalyzer object. (Inherited from Object)
ToleranceTolerance should be a small value in relation to the scene. If the distance between coordinates is less than the Tolerance the coordinates are considered to be equal.

Methods

MethodDescription
AddGeometryAdd a modular part geometry that will be analyzed later.
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
AnalyzeAll the geometries that have been added with AddGeometry() will have their shared modular seams grouped together and analyzed. The ModularSeams structure is generated and can then be fetched with GetModularSeams().
GetAutomaticModularSeamDetectionTypeGet the EAutomaticModularSeamDetectionType.
GetClassGet the name of the ModularSeamAnalyzer class. (Inherited from Object)
GetManualModularSeamDetectionTypeGet the EManualModularSeamDetectionType.
GetManualSeamArrayGet a bool array where the user can manually enter which edges should be modular seams.
GetManualSeamIdArrayGet a rid array where the user can manually enter the manual modular seam id per edge.
GetModularSeamDetectionTypeGet the EModularSeamDetectionType.
GetModularSeamsFetch the modular seam structure that was created from the geometries that had been added and analyzed. The modular seam structure contains the identified modular seams and how they should be reduced based on the geometries that were analyzed.
IsAReturns true if ModularSeamAnalyzer is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ModularSeamAnalyzer object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ModularSeamAnalyzer object is valid. (Inherited from Object)
NonNullReturns true if the ModularSeamAnalyzer object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ModularSeamAnalyzer object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetAutomaticModularSeamDetectionTypeSet EAutomaticModularSeamDetectionType to either GeometryBorders or OnlyClosed.
SetManualModularSeamDetectionTypeSet EManualModularSeamDetectionType to either SeamIdPerEdge or TogglePerEdge.
SetModularSeamDetectionTypeSet EModularSeamDetectionType to either Automatic, Manual or AutomaticAndManual.

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 spModularSeamAnalyzer, and if this is the case, returns the object cast into spModularSeamAnalyzer. (Inherited from Object)

Properties details

IsTranslationIndependent

If the modular seams are translation independent the assets don't have to align position wise next to each other. The modular seam will be identical even if the asset has been translated. This setting can only be changed before geometries have been added to the analyzer.

Name

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

Tolerance

Tolerance should be a small value in relation to the scene. If the distance between coordinates is less than the Tolerance the coordinates are considered to be equal.

Methods details

AddGeometry

Add a modular part geometry that will be analyzed later.

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Analyze

All the geometries that have been added with AddGeometry() will have their shared modular seams grouped together and analyzed. The ModularSeams structure is generated and can then be fetched with GetModularSeams().

GetAutomaticModularSeamDetectionType

Get the EAutomaticModularSeamDetectionType.

GetClass

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

GetManualModularSeamDetectionType

Get the EManualModularSeamDetectionType.

GetManualSeamArray

Get a bool array where the user can manually enter which edges should be modular seams.

GetManualSeamIdArray

Get a rid array where the user can manually enter the manual modular seam id per edge.

GetModularSeamDetectionType

Get the EModularSeamDetectionType.

GetModularSeams

Fetch the modular seam structure that was created from the geometries that had been added and analyzed. The modular seam structure contains the identified modular seams and how they should be reduced based on the geometries that were analyzed.

IsA

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

Prints the content/info of the ModularSeamAnalyzer object to the log. (Inherited from Object)

RemoveObserver

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

SetAutomaticModularSeamDetectionType

Set EAutomaticModularSeamDetectionType to either GeometryBorders or OnlyClosed.

SetManualModularSeamDetectionType

Set EManualModularSeamDetectionType to either SeamIdPerEdge or TogglePerEdge.

SetModularSeamDetectionType

Set EModularSeamDetectionType to either Automatic, Manual or AutomaticAndManual.

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 spModularSeamAnalyzer, and if this is the case, returns the object cast into spModularSeamAnalyzer. (Inherited from Object)