Simplygon 9 Documentation

# 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
UseVertexWeightsInReducer If set, and using the reduction processor, 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 willbe 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 byconverting 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
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the VertexWeightSettings class.
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.
IsNull Returns true if the VertexWeightSettings object is invalid.
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

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
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.

# Properties details

# UseVertexWeightsInReducer

If set, and using the reduction processor, 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 willbe 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 byconverting 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

                # GetBoolParameter

                Get a named parameter boolean value.

                  # GetClass

                  Get the name of the VertexWeightSettings class.

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

                                # IsNull

                                Returns true if the VertexWeightSettings object is invalid.

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

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

                                                      ← VisibilitySettings →