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

Type	Name	Min	Max	Description
`real`	maxDeviation	0.0	REAL_MAX	The max deviation target for the modular seams.

Type	Name	Min	Max	Description
`float`	maxDeviation	0.0	REAL_MAX	The max deviation target for the modular seams.

Name	Type	Min	Max	Description
maxDeviation	`float`	0.0	REAL_MAX	The max deviation target for the modular seams.

ModularSeams

The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.

Type	Name	Min	Max	Description
ModularSeams	modularSeams			The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.

Type	Name	Min	Max	Description
ModularSeams	modularSeams			The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.

Name	Type	Min	Max	Description
modularSeams	ModularSeams			The ModularSeams that have been pre-generated from the ModularSeamAnalyzer.

Name

The name of the ModularSeamSettings 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.

ReductionRatio

The reduction ratio target for the modular seams.

Type	Name	Min	Max	Description
`real`	reductionRatio	0.0	1.0	The reduction ratio target for the modular seams.

Type	Name	Min	Max	Description
`float`	reductionRatio	0.0	1.0	The reduction ratio target for the modular seams.

Name	Type	Min	Max	Description
reductionRatio	`float`	0.0	1.0	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.

Type	Name	Min	Max	Description
EStopCondition	value			The flag to which StopCondition will be set.

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.

Type	Name	Min	Max	Description
EStopCondition	value			The flag to which StopCondition will be set.

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.

Name	Type	Min	Max	Description
value	EStopCondition			The flag to which StopCondition will be set.

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.

Type	Name	Min	Max	Description
`bool`	value			The flag to which UseReductionSettingsTargets will be set.

Type	Name	Min	Max	Description
`bool`	value			The flag to which UseReductionSettingsTargets will be set.

Name	Type	Min	Max	Description
value	`bool`			The flag to which UseReductionSettingsTargets will be set.

Methods details

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.

GetBoolParameter

Get a named parameter boolean value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetClass

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

GetDoubleParameter

Get a named parameter floating point value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

GetIntParameter

Get a named parameter integer value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetStringParameter

Get a named parameter string value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetUIntParameter

Get a named parameter unsigned integer value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

IsA

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

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if ModularSeamSettings is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if ModularSeamSettings is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ModularSeamSettings is, or is a descendant of.

IsNull

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

IsSameObjectAs

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

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Name	Type	Min	Max	Description
object	Object			Object to compare with.

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)

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

SetBoolParameter

Set a named parameter boolean value.

SetDoubleParameter

Set a named parameter floating point value.

SetIntParameter

Set a named parameter integer value.

SetStringParameter

Set a named parameter string value.

SetUIntParameter

Set a named parameter unsigned integer value.

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.

ToJSON

Get settings as JSON for debugging purposes.

ValidateSettings

Validates the current settings values.

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

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ModularSeamSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

MaxDeviation ​

ModularSeams ​

Name ​

ReductionRatio ​

StopCondition ​

UseReductionSettingsTargets ​

Methods details ​

AddObserver ​

GetBoolParameter ​

GetClass ​

GetDoubleParameter ​