class ModularSeams
Properties
| Property | Description |
|---|
| Name | The name of the ModularSeams object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the ModularSeams class. (Inherited from Object) |
| GetModularSeamCount | Get the number of identified unique modular seams. |
| IsA | Returns true if ModularSeams is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ModularSeams object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ModularSeams object is valid. (Inherited from Object) |
| LoadFromFile | Loads from file. |
| NewDebugModularSeamGeometry | Get a geometry consisting of the vertices of a specific modular seam id (and an extra center vertex for debugging visibility). |
| NewModularSeamGeometryStringArray | Get a string array with the names of all the geometries that have this particular modular seam. |
| NonNull | Returns true if the ModularSeams object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ModularSeams object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SaveToFile | Saves to file. |
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 spModularSeams, and if this is the case, returns the object cast into spModularSeams. (Inherited from Object) |
Properties details
Name
The name of the ModularSeams 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
Methods details
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
GetClass
Get the name of the ModularSeams 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
GetModularSeamCount
Get the number of identified unique modular seams.
Syntax
Parameters
GetModularSeamCount takes no parameters.
Return value
Type: unsigned int
Default: 0
Syntax
Parameters
GetModularSeamCount takes no parameters.
Return value
Type: uint
Default: 0
Syntax
Parameters
GetModularSeamCount takes no parameters.
Return value
Type: int
Default: 0
IsA
Returns true if ModularSeams 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 ModularSeams 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 ModularSeams 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 ModularSeams is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ModularSeams 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 ModularSeams 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
LoadFromFile
Loads from file.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | path | | | The path of the file. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | path | | | The path of the file. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| path | str | | | The path of the file. |
Return value
Type: bool
NewDebugModularSeamGeometry
Get a geometry consisting of the vertices of a specific modular seam id (and an extra center vertex for debugging visibility).
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | modularSeamIndex | | | The index of the particular seam to fetch the geometry for. |
Return value
Type: GeometryData
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | modularSeamIndex | | | The index of the particular seam to fetch the geometry for. |
Return value
Type: GeometryData
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| modularSeamIndex | int | | | The index of the particular seam to fetch the geometry for. |
Return value
Type: GeometryData
NewModularSeamGeometryStringArray
Get a string array with the names of all the geometries that have this particular modular seam.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | modularSeamIndex | | | The index of the particular seam to fetch the geometry names for. |
Return value
Type: StringArray
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | modularSeamIndex | | | The index of the particular seam to fetch the geometry names for. |
Return value
Type: StringArray
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| modularSeamIndex | int | | | The index of the particular seam to fetch the geometry names for. |
Return value
Type: StringArray
NonNull
Returns true if the ModularSeams 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 ModularSeams 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. |
SaveToFile
Saves to file.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | path | | | The path to which the file will be saved. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | path | | | The path to which the file will be saved. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| path | str | | | The path to which the file will be saved. |
Return value
Type: bool
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 spModularSeams, and if this is the case, returns the object cast into spModularSeams. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ModularSeams
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: ModularSeams
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ModularSeams
