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) |
| 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.
Syntax
SetIsTranslationIndependent parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired IsTranslationIndependent value. |
GetIsTranslationIndependent return value
Type: bool
Default: false
Syntax
SetIsTranslationIndependent parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired IsTranslationIndependent value. |
GetIsTranslationIndependent return value
Type: bool
Default: false
Syntax
SetIsTranslationIndependent parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired IsTranslationIndependent value. |
GetIsTranslationIndependent return value
Type: bool
Default: false
Name
The name of the ModularSeamAnalyzer 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
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.
Syntax
SetTolerance parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The desired Tolerance value. |
GetTolerance return value
Type: real
Default: false
Syntax
SetTolerance parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The desired Tolerance value. |
GetTolerance return value
Type: float
Default: false
Syntax
SetTolerance parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The desired Tolerance value. |
GetTolerance return value
Type: float
Default: false
Methods details
AddGeometry
Add a modular part geometry that will be analyzed later.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | One of the geometry datas that should be analyzed for modular seeams. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | One of the geometry datas that should be analyzed for modular seeams. |
Syntax
Parameters
| 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)
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
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().
Syntax
Parameters
| 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. |
Syntax
Parameters
| 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. |
Syntax
Parameters
| 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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EAutomaticModularSeamDetectionType
| Key | Value | Comment |
|---|
| GeometryBorders | 0 | Treats all geometry borders as potential seams. |
| OnlyClosed | 1 | Only treats closed splines as potential seams. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EAutomaticModularSeamDetectionType
| Key | Value | Comment |
|---|
| GeometryBorders | 0 | Treats all geometry borders as potential seams. |
| OnlyClosed | 1 | Only treats closed splines as potential seams. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: EAutomaticModularSeamDetectionType
| 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)
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
GetManualModularSeamDetectionType
Get the EManualModularSeamDetectionType.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EManualModularSeamDetectionType
| Key | Value | Comment |
|---|
| SeamIdPerEdge | 0 | Specific and validatable modular seam IDs per edge. |
| TogglePerEdge | 1 | Set which edges should be considered modular seams. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EManualModularSeamDetectionType
| Key | Value | Comment |
|---|
| SeamIdPerEdge | 0 | Specific and validatable modular seam IDs per edge. |
| TogglePerEdge | 1 | Set which edges should be considered modular seams. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: EManualModularSeamDetectionType
| 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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geometryData | | | The GeometryData to fetch the per edge manual seams for. |
Return value
Type: BoolArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geometryData | | | The GeometryData to fetch the per edge manual seams for. |
Return value
Type: BoolArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geometryData | GeometryData | | | The GeometryData to fetch the per edge manual seams for. |
Return value
Type: BoolArray
GetManualSeamIdArray
Get a rid array where the user can manually enter the manual modular seam id per edge.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geometryData | | | The GeometryData to fetch the per edge manual seam IDs for. |
Return value
Type: RidArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geometryData | | | The GeometryData to fetch the per edge manual seam IDs for. |
Return value
Type: RidArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geometryData | GeometryData | | | The GeometryData to fetch the per edge manual seam IDs for. |
Return value
Type: RidArray
GetModularSeamDetectionType
Get the EModularSeamDetectionType.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EModularSeamDetectionType
| Key | Value | Comment |
|---|
| Automatic | 0 | Automatic detection. |
| Manual | 1 | Manual detection. |
| AutomaticAndManual | 2 | Both manual and automatic detection. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: EModularSeamDetectionType
| Key | Value | Comment |
|---|
| Automatic | 0 | Automatic detection. |
| Manual | 1 | Manual detection. |
| AutomaticAndManual | 2 | Both manual and automatic detection. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: EModularSeamDetectionType
| 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.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: ModularSeams
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: ModularSeams
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: ModularSeams
IsA
Returns true if ModularSeamAnalyzer 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 ModularSeamAnalyzer 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 ModularSeamAnalyzer 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 ModularSeamAnalyzer is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ModularSeamAnalyzer 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 ModularSeamAnalyzer 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 ModularSeamAnalyzer 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 ModularSeamAnalyzer 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. |
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)
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 spModularSeamAnalyzer, and if this is the case, returns the object cast into spModularSeamAnalyzer. (Inherited from Object)
