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)
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
UseVertexWeightsInReducer
If set, and using the ReductionProcessor or QuadReductionProcessor, the reduction will be weighted based on the weights in the "VertexWeights" vertex field.
Syntax
SetUseVertexWeightsInReducer parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVertexWeightsInReducer return value
Type: bool
Default: false
Syntax
SetUseVertexWeightsInReducer parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVertexWeightsInReducer return value
Type: bool
Default: false
Syntax
SetUseVertexWeightsInReducer parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetUseVertexWeightsInReducer return value
Type: bool
Default: false
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.
Syntax
SetUseVertexWeightsInTexcoordGenerator parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVertexWeightsInTexcoordGenerator return value
Type: bool
Default: false
Syntax
SetUseVertexWeightsInTexcoordGenerator parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value. |
GetUseVertexWeightsInTexcoordGenerator return value
Type: bool
Default: false
Syntax
SetUseVertexWeightsInTexcoordGenerator parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value. |
GetUseVertexWeightsInTexcoordGenerator return value
Type: bool
Default: false
WeightsFromColorComponent
If converting vertex colors to weights, this setting controls which color component is used to create the weights.
Syntax
SetWeightsFromColorComponent parameters
| Type | Name | Min | Max | Description |
|---|
| EColorComponent | value | | | The desired WeightsFromColorComponent. |
GetWeightsFromColorComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| Red | 0 | Red color component |
| Green | 1 | Green color component |
| Blue | 2 | Blue color component |
| Alpha | 3 | Alpha color component |
Syntax
SetWeightsFromColorComponent parameters
| Type | Name | Min | Max | Description |
|---|
| EColorComponent | value | | | The desired WeightsFromColorComponent. |
GetWeightsFromColorComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| Red | 0 | Red color component |
| Green | 1 | Green color component |
| Blue | 2 | Blue color component |
| Alpha | 3 | Alpha color component |
Syntax
SetWeightsFromColorComponent parameters
| Name | Type | Min | Max | Description |
|---|
| value | EColorComponent | | | The desired WeightsFromColorComponent. |
GetWeightsFromColorComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| EColorComponent_Red | 0 | Red color component |
| EColorComponent_Green | 1 | Green color component |
| EColorComponent_Blue | 2 | Blue color component |
| EColorComponent_Alpha | 3 | Alpha color component |
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.
Syntax
SetWeightsFromColorLevel parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | | The desired vertex color field level. |
GetWeightsFromColorLevel return value
Type: rid
Default: -1
Syntax
SetWeightsFromColorLevel parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | | The desired vertex color field level. |
GetWeightsFromColorLevel return value
Type: int
Default: -1
Syntax
SetWeightsFromColorLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | | The desired vertex color field level. |
GetWeightsFromColorLevel return value
Type: int
Default: -1
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].
Syntax
SetWeightsFromColorMode parameters
GetWeightsFromColorMode return value
Type: EWeightsFromColorMode
Default: Standard
| Key | Value | Comment |
|---|
| Standard | 0 | Maps color intensity [0-1] to vertex weight [1/Multiplier - Multiplier] |
| High | 1 | Maps color intensity [0-1] to vertex weight [1 - Multiplier] |
| Low | 2 | Maps color intensity [0-1] to vertex weight [1/Multiplier - 1] |
Syntax
SetWeightsFromColorMode parameters
GetWeightsFromColorMode return value
Type: EWeightsFromColorMode
Default: Standard
| Key | Value | Comment |
|---|
| Standard | 0 | Maps color intensity [0-1] to vertex weight [1/Multiplier - Multiplier] |
| High | 1 | Maps color intensity [0-1] to vertex weight [1 - Multiplier] |
| Low | 2 | Maps color intensity [0-1] to vertex weight [1/Multiplier - 1] |
Syntax
SetWeightsFromColorMode parameters
GetWeightsFromColorMode return value
Type: EWeightsFromColorMode
Default: Standard
| Key | Value | Comment |
|---|
| EWeightsFromColorMode_Standard | 0 | Maps color intensity [0-1] to vertex weight [1/Multiplier - Multiplier] |
| EWeightsFromColorMode_High | 1 | Maps color intensity [0-1] to vertex weight [1 - Multiplier] |
| EWeightsFromColorMode_Low | 2 | 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.
Syntax
SetWeightsFromColorMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0.0 | 10.0 | The new WeightsFromColorMultiplier. |
GetWeightsFromColorMultiplier return value
Type: real
Default: 4.0
Syntax
SetWeightsFromColorMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0.0 | 10.0 | The new WeightsFromColorMultiplier. |
GetWeightsFromColorMultiplier return value
Type: float
Default: 4.0
Syntax
SetWeightsFromColorMultiplier parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0.0 | 10.0 | The new WeightsFromColorMultiplier. |
GetWeightsFromColorMultiplier return value
Type: float
Default: 4.0
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.
Syntax
SetWeightsFromColorName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired vertex color field name. |
GetWeightsFromColorName return value
Type: spString
Default: nullptr
Syntax
SetWeightsFromColorName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired vertex color field name. |
GetWeightsFromColorName return value
Type: string
Default: null
Syntax
SetWeightsFromColorName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired vertex color field name. |
GetWeightsFromColorName return value
Type: str
Default: None
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 VertexWeightSettings 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 VertexWeightSettings 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 VertexWeightSettings 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 VertexWeightSettings 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 VertexWeightSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the VertexWeightSettings 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 VertexWeightSettings 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 VertexWeightSettings 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 VertexWeightSettings 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 spVertexWeightSettings, and if this is the case, returns the object cast into spVertexWeightSettings. (Inherited from Object)
