class ModularSeamSettings
Properties
| Property | Description |
|---|
| MaxDeviation | The max deviation target for the modular seams. |
| ModularSeams | The ModularSeams that have been pre-generated from the ModularSeamAnalyzer. |
| Name | The name of the ModularSeamSettings object. (Inherited from Object) |
| ReductionRatio | The reduction ratio target for the modular seams. |
| StopCondition | The StopCondition decides whether both or any of the ReductionRatio and MaxDeviation targets should be used. |
| UseReductionSettingsTargets | If true, the reduction ratio and max deviation will be set from the ReductionSettings' targets. However, TriangleCount and OnScreenSize are not valid targets for the modular seam reduction. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the ModularSeamSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if ModularSeamSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ModularSeamSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ModularSeamSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the ModularSeamSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ModularSeamSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
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 spModularSeamSettings, and if this is the case, returns the object cast into spModularSeamSettings. (Inherited from Object) |
Properties details
MaxDeviation
The max deviation target for the modular seams.
Syntax
SetMaxDeviation parameters
| Type | Name | Min | Max | Description |
|---|
real | maxDeviation | 0.0 | REAL_MAX | The max deviation target for the modular seams. |
GetMaxDeviation return value
Type: real
Default: REAL_MAX
Syntax
SetMaxDeviation parameters
| Type | Name | Min | Max | Description |
|---|
float | maxDeviation | 0.0 | REAL_MAX | The max deviation target for the modular seams. |
GetMaxDeviation return value
Type: float
Default: REAL_MAX
Syntax
SetMaxDeviation parameters
| Name | Type | Min | Max | Description |
|---|
| maxDeviation | float | 0.0 | REAL_MAX | The max deviation target for the modular seams. |
GetMaxDeviation return value
Type: float
Default: REAL_MAX
ModularSeams
The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.
Syntax
SetModularSeams parameters
| Type | Name | Min | Max | Description |
|---|
| ModularSeams | modularSeams | | | The ModularSeams that have been pre-generated from the ModularSeamAnalyzer. |
GetModularSeams return value
Type: ModularSeams
Syntax
SetModularSeams parameters
| Type | Name | Min | Max | Description |
|---|
| ModularSeams | modularSeams | | | The ModularSeams that have been pre-generated from the ModularSeamAnalyzer. |
GetModularSeams return value
Type: ModularSeams
Syntax
SetModularSeams parameters
| Name | Type | Min | Max | Description |
|---|
| modularSeams | ModularSeams | | | The ModularSeams that have been pre-generated from the ModularSeamAnalyzer. |
GetModularSeams return value
Type: ModularSeams
Name
The name of the ModularSeamSettings 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
ReductionRatio
The reduction ratio target for the modular seams.
Syntax
SetReductionRatio parameters
| Type | Name | Min | Max | Description |
|---|
real | reductionRatio | 0.0 | 1.0 | The reduction ratio target for the modular seams. |
GetReductionRatio return value
Type: real
Default: 0.5
Syntax
SetReductionRatio parameters
| Type | Name | Min | Max | Description |
|---|
float | reductionRatio | 0.0 | 1.0 | The reduction ratio target for the modular seams. |
GetReductionRatio return value
Type: float
Default: 0.5
Syntax
SetReductionRatio parameters
| Name | Type | Min | Max | Description |
|---|
| reductionRatio | float | 0.0 | 1.0 | The reduction ratio target for the modular seams. |
GetReductionRatio return value
Type: float
Default: 0.5
StopCondition
The StopCondition decides whether both or any of the ReductionRatio and MaxDeviation targets should be used.
Syntax
SetStopCondition parameters
| Type | Name | Min | Max | Description |
|---|
| EStopCondition | value | | | The flag to which StopCondition will be set. |
GetStopCondition return value
Type: EStopCondition
Default: Any
| Key | Value | Comment |
|---|
| Any | 0 | Simplygon will stop as soon as one of the reduction targets has been fulfilled. |
| All | 1 | Simplygon will continue processing until all of the reduction targets have been fulfilled. |
Syntax
SetStopCondition parameters
| Type | Name | Min | Max | Description |
|---|
| EStopCondition | value | | | The flag to which StopCondition will be set. |
GetStopCondition return value
Type: EStopCondition
Default: Any
| Key | Value | Comment |
|---|
| Any | 0 | Simplygon will stop as soon as one of the reduction targets has been fulfilled. |
| All | 1 | Simplygon will continue processing until all of the reduction targets have been fulfilled. |
Syntax
SetStopCondition parameters
| Name | Type | Min | Max | Description |
|---|
| value | EStopCondition | | | The flag to which StopCondition will be set. |
GetStopCondition return value
Type: EStopCondition
Default: Any
| Key | Value | Comment |
|---|
| EStopCondition_Any | 0 | Simplygon will stop as soon as one of the reduction targets has been fulfilled. |
| EStopCondition_All | 1 | Simplygon will continue processing until all of the reduction targets have been fulfilled. |
UseReductionSettingsTargets
If true, the reduction ratio and max deviation will be set from the ReductionSettings' targets. However, TriangleCount and OnScreenSize are not valid targets for the modular seam reduction.
Syntax
SetUseReductionSettingsTargets parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to which UseReductionSettingsTargets will be set. |
GetUseReductionSettingsTargets return value
Type: bool
Default: false
Syntax
SetUseReductionSettingsTargets parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to which UseReductionSettingsTargets will be set. |
GetUseReductionSettingsTargets return value
Type: bool
Default: false
Syntax
SetUseReductionSettingsTargets parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The flag to which UseReductionSettingsTargets will be set. |
GetUseReductionSettingsTargets return value
Type: bool
Default: false
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
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the ModularSeamSettings 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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if ModularSeamSettings 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 ModularSeamSettings 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 ModularSeamSettings 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 ModularSeamSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ModularSeamSettings 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 ModularSeamSettings 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 ModularSeamSettings 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 ModularSeamSettings 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. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
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 spModularSeamSettings, and if this is the case, returns the object cast into spModularSeamSettings. (Inherited from Object)
