`class` ModularSeamAnalyzer

Properties

Property	Description
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)
OnlyAnalyzeSharedSeams	Only analyze and deterministically reduce modular seams that are referenced multiple times, either by multiple geometries or multiple times within the same geometry. If true, will ignore modular seams that have a single reference
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

Method	Description
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

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

Type	Name	Min	Max	Description
`bool`	value			The desired IsTranslationIndependent value.

Type	Name	Min	Max	Description
`bool`	value			The desired IsTranslationIndependent value.

Name	Type	Min	Max	Description
value	`bool`			The desired IsTranslationIndependent value.

Name

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

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

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

OnlyAnalyzeSharedSeams

Only analyze and deterministically reduce modular seams that are referenced multiple times, either by multiple geometries or multiple times within the same geometry. If true, will ignore modular seams that have a single reference

Type	Name	Min	Max	Description
`bool`	value			The desired OnlyAnalyzeSharedSeams value.

Type	Name	Min	Max	Description
`bool`	value			The desired OnlyAnalyzeSharedSeams value.

Name	Type	Min	Max	Description
value	`bool`			The desired OnlyAnalyzeSharedSeams value.

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.

Type	Name	Min	Max	Description
`real`	value			The desired Tolerance value.

Type	Name	Min	Max	Description
`float`	value			The desired Tolerance value.

Name	Type	Min	Max	Description
value	`float`			The desired Tolerance value.

Methods details

AddGeometry

Add a modular part geometry that will be analyzed later.

Type	Name	Min	Max	Description
GeometryData	geom			One of the geometry datas that should be analyzed for modular seeams.

Type	Name	Min	Max	Description
GeometryData	geom			One of the geometry datas that should be analyzed for modular seeams.

Name	Type	Min	Max	Description
geom	GeometryData			One of the geometry datas that should be analyzed for modular seeams.

AddObserver

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

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

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

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

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

Type	Name	Min	Max	Description
ReductionSettings	reductionSettings			The reduction settings contains the reduction preferences that the analyzer takes into account for how to reduce the geometries along the modular seams. By changing the feature importances the geometry will prioritize different collapses and scale the maximum deviation accordingly.

Type	Name	Min	Max	Description
ReductionSettings	reductionSettings			The reduction settings contains the reduction preferences that the analyzer takes into account for how to reduce the geometries along the modular seams. By changing the feature importances the geometry will prioritize different collapses and scale the maximum deviation accordingly.

Name	Type	Min	Max	Description
reductionSettings	ReductionSettings			The reduction settings contains the reduction preferences that the analyzer takes into account for how to reduce the geometries along the modular seams. By changing the feature importances the geometry will prioritize different collapses and scale the maximum deviation accordingly.

GetAutomaticModularSeamDetectionType

Get the EAutomaticModularSeamDetectionType.

Key	Value	Comment
GeometryBorders	0	Treats all geometry borders as potential seams.
OnlyClosed	1	Only treats closed splines as potential seams.

Key	Value	Comment
GeometryBorders	0	Treats all geometry borders as potential seams.
OnlyClosed	1	Only treats closed splines as potential seams.

Key	Value	Comment
EAutomaticModularSeamDetectionType_GeometryBorders	0	Treats all geometry borders as potential seams.
EAutomaticModularSeamDetectionType_OnlyClosed	1	Only treats closed splines as potential seams.

GetClass

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

GetManualModularSeamDetectionType

Get the EManualModularSeamDetectionType.

Key	Value	Comment
SeamIdPerEdge	0	Specific and validatable modular seam IDs per edge.
TogglePerEdge	1	Set which edges should be considered modular seams.

Key	Value	Comment
SeamIdPerEdge	0	Specific and validatable modular seam IDs per edge.
TogglePerEdge	1	Set which edges should be considered modular seams.

Key	Value	Comment
EManualModularSeamDetectionType_SeamIdPerEdge	0	Specific and validatable modular seam IDs per edge.
EManualModularSeamDetectionType_TogglePerEdge	1	Set which edges should be considered modular seams.

GetManualSeamArray

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

Type	Name	Min	Max	Description
GeometryData	geometryData			The GeometryData to fetch the per edge manual seams for.

Type	Name	Min	Max	Description
GeometryData	geometryData			The GeometryData to fetch the per edge manual seams for.

Name	Type	Min	Max	Description
geometryData	GeometryData			The GeometryData to fetch the per edge manual seams for.

GetManualSeamIdArray

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

Type	Name	Min	Max	Description
GeometryData	geometryData			The GeometryData to fetch the per edge manual seam IDs for.

Type	Name	Min	Max	Description
GeometryData	geometryData			The GeometryData to fetch the per edge manual seam IDs for.

Name	Type	Min	Max	Description
geometryData	GeometryData			The GeometryData to fetch the per edge manual seam IDs for.

GetModularSeamDetectionType

Get the EModularSeamDetectionType.

Key	Value	Comment
Automatic	0	Automatic detection.
Manual	1	Manual detection.
AutomaticAndManual	2	Both manual and automatic detection.

Key	Value	Comment
Automatic	0	Automatic detection.
Manual	1	Manual detection.
AutomaticAndManual	2	Both manual and automatic detection.

Key	Value	Comment
EModularSeamDetectionType_Automatic	0	Automatic detection.
EModularSeamDetectionType_Manual	1	Manual detection.
EModularSeamDetectionType_AutomaticAndManual	2	Both manual and automatic detection.

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)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ModularSeamAnalyzer ​

Properties ​

Methods ​

Static methods ​

Properties details ​

IsTranslationIndependent ​

Name ​

OnlyAnalyzeSharedSeams ​

Tolerance ​

Methods details ​

AddGeometry ​

AddObserver ​

Analyze ​

GetAutomaticModularSeamDetectionType ​

GetClass ​

GetManualModularSeamDetectionType ​

GetManualSeamArray ​