class ChartAggregatorSettings
Settings for the chart aggregator.
Properties
| Property | Description |
|---|
| ChartAggregatorMode | Determines which method to use when aggregating the UVs. TextureSizeProportions - Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea - Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity - The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions - Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in. |
| LockUVRotation | Only used when the TexCoordGeneratorType is ChartAggregator. If ChartAggregatorLockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations). |
| OriginalChartProportionsChannel | Only used when the TexCoordGeneratorType is ChartAggregator. Set ChartAggregatorKeepOriginalChartProportionsFromChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart proportions to keep. |
| OriginalTexCoordLevel | Only used when the TexCoordGeneratorType is ChartAggregator. Set the texture coordinate level to get charts from. If the ChartAggregatorOriginalTexCoordName ha been set, the ChartAggregatorOriginalTexCoordLevel is not used. |
| OriginalTexCoordName | Only used when the TexCoordGeneratorType is ChartAggregator. Set the name of the texture coordinate level to get charts from. If not set, it will use the ChartAggregatorOriginalTexCoordLevel (index) instead. |
| SeparateOverlappingCharts | Only used when the TexCoordGeneratorType is ChartAggregator. If set, charts that are overlapping in the original texture coords will be separated. |
| SurfaceAreaScale | If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
Methods
| Method | Description |
|---|
| GetBoolParameter | Get a named parameter boolean value. |
| GetClass | Get the name of the ChartAggregatorSettings 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 ChartAggregatorSettings is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the ChartAggregatorSettings 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 spChartAggregatorSettings, and if this is the case, returns the object cast into spChartAggregatorSettings. |
Properties details
ChartAggregatorMode
Determines which method to use when aggregating the UVs. TextureSizeProportions - Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea - Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity - The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions - Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.
Syntax
SetChartAggregatorMode parameters
GetChartAggregatorMode return value
Type: EChartAggregatorMode
Default: TextureSizeProportions
| Key | Value | Comment |
|---|
| TextureSizeProportions | 0 | Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. |
| SurfaceArea | 1 | Aggregated UV charts will have their size set based on its actual geometrical size. |
| OriginalPixelDensity | 2 | The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. |
| UVSizeProportions | 3 | Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in. |
Syntax
SetChartAggregatorMode parameters
GetChartAggregatorMode return value
Type: ``````
Default: TextureSizeProportions
| Key | Value | Comment |
|---|
| TextureSizeProportions | 0 | Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. |
| SurfaceArea | 1 | Aggregated UV charts will have their size set based on its actual geometrical size. |
| OriginalPixelDensity | 2 | The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. |
| UVSizeProportions | 3 | Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in. |
Syntax
SetChartAggregatorMode parameters
GetChartAggregatorMode return value
Type: EChartAggregatorMode
Default: TextureSizeProportions
| Key | Value | Comment |
|---|
| EChartAggregatorMode_TextureSizeProportions | 0 | Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. |
| EChartAggregatorMode_SurfaceArea | 1 | Aggregated UV charts will have their size set based on its actual geometrical size. |
| EChartAggregatorMode_OriginalPixelDensity | 2 | The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. |
| EChartAggregatorMode_UVSizeProportions | 3 | Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in. |
LockUVRotation
Only used when the TexCoordGeneratorType is ChartAggregator. If ChartAggregatorLockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations).
Syntax
SetLockUVRotation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new LockUVRotation. |
GetLockUVRotation return value
Type: bool
Default: false
Syntax
SetLockUVRotation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new LockUVRotation. |
GetLockUVRotation return value
Type: bool
Default: false
Syntax
SetLockUVRotation parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new LockUVRotation. |
GetLockUVRotation return value
Type: bool
Default: false
OriginalChartProportionsChannel
Only used when the TexCoordGeneratorType is ChartAggregator. Set ChartAggregatorKeepOriginalChartProportionsFromChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart proportions to keep.
Syntax
SetOriginalChartProportionsChannel parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The new ChartAggregatorKeepOriginalChartProportionsFromChannel value. |
GetOriginalChartProportionsChannel return value
Type: spString
Default: Diffuse
Syntax
SetOriginalChartProportionsChannel parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The new ChartAggregatorKeepOriginalChartProportionsFromChannel value. |
GetOriginalChartProportionsChannel return value
Type: string
Default: Diffuse
Syntax
SetOriginalChartProportionsChannel parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The new ChartAggregatorKeepOriginalChartProportionsFromChannel value. |
GetOriginalChartProportionsChannel return value
Type: str
Default: Diffuse
OriginalTexCoordLevel
Only used when the TexCoordGeneratorType is ChartAggregator. Set the texture coordinate level to get charts from. If the ChartAggregatorOriginalTexCoordName ha been set, the ChartAggregatorOriginalTexCoordLevel is not used.
Syntax
SetOriginalTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | INT_MAX | The desired texture coordinate level. |
GetOriginalTexCoordLevel return value
Type: rid
Default: 0
Syntax
SetOriginalTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | INT_MAX | The desired texture coordinate level. |
GetOriginalTexCoordLevel return value
Type: rid
Default: 0
Syntax
SetOriginalTexCoordLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | INT_MAX | The desired texture coordinate level. |
GetOriginalTexCoordLevel return value
Type: int
Default: 0
OriginalTexCoordName
Only used when the TexCoordGeneratorType is ChartAggregator. Set the name of the texture coordinate level to get charts from. If not set, it will use the ChartAggregatorOriginalTexCoordLevel (index) instead.
Syntax
SetOriginalTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired texture coordinate level name. |
GetOriginalTexCoordName return value
Type: spString
Default: nullptr
Syntax
SetOriginalTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired texture coordinate level name. |
GetOriginalTexCoordName return value
Type: string
Default: null
Syntax
SetOriginalTexCoordName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired texture coordinate level name. |
GetOriginalTexCoordName return value
Type: str
Default: None
SeparateOverlappingCharts
Only used when the TexCoordGeneratorType is ChartAggregator. If set, charts that are overlapping in the original texture coords will be separated.
Syntax
SetSeparateOverlappingCharts parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which ChartAggregatorSeparateOverlappingCharts is set. |
GetSeparateOverlappingCharts return value
Type: bool
Default: false
Syntax
SetSeparateOverlappingCharts parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which ChartAggregatorSeparateOverlappingCharts is set. |
GetSeparateOverlappingCharts return value
Type: bool
Default: false
Syntax
SetSeparateOverlappingCharts parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which ChartAggregatorSeparateOverlappingCharts is set. |
GetSeparateOverlappingCharts return value
Type: bool
Default: false
SurfaceAreaScale
If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.
Syntax
SetSurfaceAreaScale parameters
| Type | Name | Min | Max | Description |
|---|
| ESurfaceAreaScale | value | | | The SurfaceAreaScale value to use. |
GetSurfaceAreaScale return value
Type: ESurfaceAreaScale
Default: LargestInstance
| Key | Value | Comment |
|---|
| LargestInstance | 0 | If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| SmallestInstance | 1 | If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| Average | 2 | If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
Syntax
SetSurfaceAreaScale parameters
| Type | Name | Min | Max | Description |
|---|
| ESurfaceAreaScale | value | | | The SurfaceAreaScale value to use. |
GetSurfaceAreaScale return value
Type: ``````
Default: LargestInstance
| Key | Value | Comment |
|---|
| LargestInstance | 0 | If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| SmallestInstance | 1 | If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| Average | 2 | If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
Syntax
SetSurfaceAreaScale parameters
| Name | Type | Min | Max | Description |
|---|
| value | ESurfaceAreaScale | | | The SurfaceAreaScale value to use. |
GetSurfaceAreaScale return value
Type: ESurfaceAreaScale
Default: LargestInstance
| Key | Value | Comment |
|---|
| ESurfaceAreaScale_LargestInstance | 0 | If multiple UV charts overlap and have the same material, the largest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| ESurfaceAreaScale_SmallestInstance | 1 | If multiple UV charts overlap and have the same material, the smallest instance determines the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
| ESurfaceAreaScale_Average | 2 | If multiple UV charts overlap and have the same material, the average of all the instances determine the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false. |
Methods details
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 ChartAggregatorSettings class.
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 ChartAggregatorSettings is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ChartAggregatorSettings 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 ChartAggregatorSettings 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 ChartAggregatorSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ChartAggregatorSettings object is invalid.
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
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.
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 spChartAggregatorSettings, and if this is the case, returns the object cast into spChartAggregatorSettings.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ChartAggregatorSettings
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ChartAggregatorSettings
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ChartAggregatorSettings
