class MappingImageOutputMaterialSettings
Settings for the Simplygon mapping output.
Properties
| Property | Description |
|---|
| GutterSpace | The minimum number of pixels between charts of the output mapping image. |
| MultisamplingLevel | The multi-sampling level of the output mapping image. Values 1-8 are accepted. |
| 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 |
|---|
| GetBoolParameter | Get a named parameter boolean value. |
| GetClass | Get the name of the MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the MappingImageOutputMaterialSettings 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 spMappingImageOutputMaterialSettings, and if this is the case, returns the object cast into spMappingImageOutputMaterialSettings. |
Properties details
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
MultisamplingLevel
The multi-sampling level of the output mapping image. Values 1-8 are accepted.
Syntax
SetMultisamplingLevel parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 1 | 8 | The value to which MultiSamplingLevel will be set. |
GetMultisamplingLevel return value
Type: unsigned int
Default: 2
Syntax
SetMultisamplingLevel parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 1 | 8 | The value to which MultiSamplingLevel will be set. |
GetMultisamplingLevel return value
Type: uint
Default: 2
Syntax
SetMultisamplingLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 1 | 8 | The value to which MultiSamplingLevel will be set. |
GetMultisamplingLevel return value
Type: int
Default: 2
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: 1024
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: 1024
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: 1024
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: 1024
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: 1024
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: 1024
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 MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the MappingImageOutputMaterialSettings 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 spMappingImageOutputMaterialSettings, and if this is the case, returns the object cast into spMappingImageOutputMaterialSettings.
