Simplygon 10.3.2100.0
class VertexWeightSettings
This settings object contains all settings related to how the user-set weighting field "VertexWeights" is setup and used in different contexts. The values in the field can be considered an "importance" factor. Generally, weights set to 1.0 are handled normally, values >1.0 are given greater importance, and values <1.0 are given less. These weights can either be manually set in the input geometry data or converted from vertex color sets using the WeightsFromColor settings. See the documentation of the WeightsFromColorMode property to see the details of how color intensity is mapped to vertex weight. Vertex weights can be used to reduce more or less aggressively on different parts of the mesh, or used to scale UV allocation in the parameterizers to give more or less texture area to different areas.
Properties
| Property | Description |
|---|---|
| Name | The name of the VertexWeightSettings object. (Inherited from Object) |
| UseVertexWeightsInReducer | If set, and using the ReductionProcessor or QuadReductionProcessor, the reduction will be weighted based on the weights in the "VertexWeights" vertex field. |
| UseVertexWeightsInTexcoordGenerator | If set, and generating new texcoords using either the parameterizeror the chart aggregator, the relative sizes of the output charts will be scaled using the weights in the "VertexWeights" vertex field. |
| WeightsFromColorComponent | If converting vertex colors to weights, this setting controls which color component is used to create the weights. |
| WeightsFromColorLevel | If the index of an existing vertex color field in the input geometry is set here, the existing VertexWeights field will be overwritten by a set created by converting the selected color field according to the other WeightsFromColor settings in this settings object. If both this and the corresponding ColorName is set, the processors will prioritize the name. |
| WeightsFromColorMode | If converting vertex colors to weights, this setting along with WeightsFromColorMultiplier controls how to map the RGBA intensity between 0-1 to weights. Standard mode maps color intensity [0-1] to vertex weight [1/Multiplier - Multiplier]. High mode maps color intensity [0-1] to vertex weight [1 - Multiplier]. Low mode maps color intensity [0-1] to vertex weight [1/Multiplier - 1]. |
| WeightsFromColorMultiplier | If converting vertex colors to weights, this setting controls the max and min resulting vertex weights generated by the input color. |
| WeightsFromColorName | If the name of an existing vertex color field in the input geometry is set here, the existing VertexWeights field will be overwritten by a set created by converting the selected color field according to the other WeightsFromColor settings in this settings object. If both ColorName and the corresponding ColorLevel is set, the processors will prioritize the name. |
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 VertexWeightSettings 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 VertexWeightSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the VertexWeightSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the VertexWeightSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the VertexWeightSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the VertexWeightSettings 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 spVertexWeightSettings, and if this is the case, returns the object cast into spVertexWeightSettings. (Inherited from Object) |
Properties details
Name
The name of the VertexWeightSettings object. (Inherited from Object)
UseVertexWeightsInReducer
If set, and using the ReductionProcessor or QuadReductionProcessor, the reduction will be weighted based on the weights in the "VertexWeights" vertex field.
UseVertexWeightsInTexcoordGenerator
If set, and generating new texcoords using either the parameterizeror the chart aggregator, the relative sizes of the output charts will be scaled using the weights in the "VertexWeights" vertex field.
WeightsFromColorComponent
If converting vertex colors to weights, this setting controls which color component is used to create the weights.
WeightsFromColorLevel
If the index of an existing vertex color field in the input geometry is set here, the existing VertexWeights field will be overwritten by a set created by converting the selected color field according to the other WeightsFromColor settings in this settings object. If both this and the corresponding ColorName is set, the processors will prioritize the name.
WeightsFromColorMode
If converting vertex colors to weights, this setting along with WeightsFromColorMultiplier controls how to map the RGBA intensity between 0-1 to weights. Standard mode maps color intensity [0-1] to vertex weight [1/Multiplier - Multiplier]. High mode maps color intensity [0-1] to vertex weight [1 - Multiplier]. Low mode maps color intensity [0-1] to vertex weight [1/Multiplier - 1].
WeightsFromColorMultiplier
If converting vertex colors to weights, this setting controls the max and min resulting vertex weights generated by the input color.
WeightsFromColorName
If the name of an existing vertex color field in the input geometry is set here, the existing VertexWeights field will be overwritten by a set created by converting the selected color field according to the other WeightsFromColor settings in this settings object. If both ColorName and the corresponding ColorLevel is set, the processors will prioritize the name.
Methods details
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.
GetClass
Get the name of the VertexWeightSettings class. (Inherited from Object)
GetDoubleParameter
Get a named parameter floating point value.
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
GetIntParameter
Get a named parameter integer value.
GetStringParameter
Get a named parameter string value.
GetUIntParameter
Get a named parameter unsigned integer value.
IsA
Returns true if VertexWeightSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the VertexWeightSettings object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the VertexWeightSettings object is valid. (Inherited from Object)
NonNull
Returns true if the VertexWeightSettings object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the VertexWeightSettings object to the log. (Inherited from Object)
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
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 spVertexWeightSettings, and if this is the case, returns the object cast into spVertexWeightSettings. (Inherited from Object)