class GenerateLightmapTexCoordSettings
GenerateLightmapTexCoordSettings is the interface used to manage light map uv generation.
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.");. |
| GenerateLightmapTexCoord | Property for whether to generate an extra set of TexCoords for LightMapping. |
| GutterSpace | The minimum number of pixels between charts of the output mapping image. |
| LightmapTexCoordLevel | The texture coordinate level used for storing the LightMap UVs. The texcoord name has priority over level. If neither name or level is set then output would be level 0. |
| LightmapTexCoordName | The texture coordinate level name used for storing the generated Lightmap UVs. If this is not set will default to level. If neither name or level is set then output would be level 0. |
| Name | The name of the GenerateLightmapTexCoordSettings object. (Inherited from Object) |
| TextureHeight | The height of the texture of the output mapping image. |
| TextureWidth | The width of the texture of the output mapping image. |
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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the GenerateLightmapTexCoordSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the GenerateLightmapTexCoordSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the GenerateLightmapTexCoordSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the GenerateLightmapTexCoordSettings 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 spGenerateLightmapTexCoordSettings, and if this is the case, returns the object cast into spGenerateLightmapTexCoordSettings. (Inherited from Object) |
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: SurfaceArea
| 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: SurfaceArea
| 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: SurfaceArea
| 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. |
GenerateLightmapTexCoord
Property for whether to generate an extra set of TexCoords for LightMapping.
Syntax
SetGenerateLightmapTexCoord parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new value. |
GetGenerateLightmapTexCoord return value
Type: bool
Default: false
Syntax
SetGenerateLightmapTexCoord parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The new value. |
GetGenerateLightmapTexCoord return value
Type: bool
Default: false
Syntax
SetGenerateLightmapTexCoord parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The new value. |
GetGenerateLightmapTexCoord return value
Type: bool
Default: false
GutterSpace
The minimum number of pixels between charts of the output mapping image.
Syntax
SetGutterSpace parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The value to which GutterSpace will be set. |
GetGutterSpace return value
Type: unsigned int
Default: 4
Syntax
SetGutterSpace parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The value to which GutterSpace will be set. |
GetGutterSpace return value
Type: uint
Default: 4
Syntax
SetGutterSpace parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The value to which GutterSpace will be set. |
GetGutterSpace return value
Type: int
Default: 4
LightmapTexCoordLevel
The texture coordinate level used for storing the LightMap UVs. The texcoord name has priority over level. If neither name or level is set then output would be level 0.
Syntax
SetLightmapTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | -1 | INT_MAX | The desired texture coordinate level. |
GetLightmapTexCoordLevel return value
Type: rid
Default: -1
Syntax
SetLightmapTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
int | value | -1 | INT_MAX | The desired texture coordinate level. |
GetLightmapTexCoordLevel return value
Type: int
Default: -1
Syntax
SetLightmapTexCoordLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | -1 | INT_MAX | The desired texture coordinate level. |
GetLightmapTexCoordLevel return value
Type: int
Default: -1
LightmapTexCoordName
The texture coordinate level name used for storing the generated Lightmap UVs. If this is not set will default to level. If neither name or level is set then output would be level 0.
Syntax
SetLightmapTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The TexCoord level name. |
GetLightmapTexCoordName return value
Type: spString
Default: nullptr
Syntax
SetLightmapTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The TexCoord level name. |
GetLightmapTexCoordName return value
Type: string
Default: null
Syntax
SetLightmapTexCoordName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The TexCoord level name. |
GetLightmapTexCoordName return value
Type: str
Default: None
Name
The name of the GenerateLightmapTexCoordSettings 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
TextureHeight
The height of the texture of the output mapping image.
Syntax
SetTextureHeight parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The value to which Height will be set. |
GetTextureHeight return value
Type: unsigned int
Default: 512
Syntax
SetTextureHeight parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The value to which Height will be set. |
GetTextureHeight return value
Type: uint
Default: 512
Syntax
SetTextureHeight parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The value to which Height will be set. |
GetTextureHeight return value
Type: int
Default: 512
TextureWidth
The width of the texture of the output mapping image.
Syntax
SetTextureWidth parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The value to which Width will be set. |
GetTextureWidth return value
Type: unsigned int
Default: 512
Syntax
SetTextureWidth parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The value to which Width will be set. |
GetTextureWidth return value
Type: uint
Default: 512
Syntax
SetTextureWidth parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The value to which Width will be set. |
GetTextureWidth return value
Type: int
Default: 512
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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 GenerateLightmapTexCoordSettings 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 spGenerateLightmapTexCoordSettings, and if this is the case, returns the object cast into spGenerateLightmapTexCoordSettings. (Inherited from Object)
