class AttributeTessellationSettings
Attribute tessellation settings contains the parameters for how to compute the tessellation attributes of geometries in a scene.
Properties
| Property | Description |
|---|
| AttributeTessellationDensityMode | Setting how Simplygon is to calculate or set the tessellation levels for per-triangle regular tessellated attributes. |
| EnableAttributeTessellation | If set to true, attribute tessellation will be calculated on the geometries in the scene. |
| MaxAreaOfTessellatedValue | Setting specific for 'RelativeArea' or 'AbsoluteArea' tessellation density modes. The processor will tessellate a triangle until each value's area is equal or less than the MaxAreaOfTessellatedValue ratio or value, as defined by the mode. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level. |
| MaxLengthOfTessellatedValue | Setting specific for 'RelativeLengthBased' tessellation density mode. The processor will tessellate the values of a triangle until each value's longest edge is equal or less than the MaxLengthOfTessellatedValue ratio value, as defined by the mode. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level. |
| MaxTessellationLevel | General tessellation setting. The maximum level of value tessellation allowed for any one triangle. |
| MaxTotalValuesCount | General tessellation setting. The maximum number of values total allowed for one geometry. |
| MinTessellationLevel | General tessellation setting. The minimum level of value tessellation allowed for any one triangle. |
| Name | The name of the AttributeTessellationSettings object. (Inherited from Object) |
| OnlyAllowOneLevelOfDifference | General tessellation setting. If enabled, only allow a difference of one level between neighbor triangles. This is required by some file formats that store attribute data. |
| TransformationSpace | The transformation space the evaluation should be done in. Valid values are Global and Local. |
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 AttributeTessellationSettings 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 AttributeTessellationSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the AttributeTessellationSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the AttributeTessellationSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the AttributeTessellationSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the AttributeTessellationSettings 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 spAttributeTessellationSettings, and if this is the case, returns the object cast into spAttributeTessellationSettings. (Inherited from Object) |
Properties details
AttributeTessellationDensityMode
Setting how Simplygon is to calculate or set the tessellation levels for per-triangle regular tessellated attributes.
Syntax
SetAttributeTessellationDensityMode parameters
GetAttributeTessellationDensityMode return value
Type: EAttributeTessellationDensityMode
Default: RelativeArea
| Key | Value | Comment |
|---|
| RelativeArea | 0 | Base tessellation density on the relative area of the tessellated attribute, as a fraction of the total area of the surface of the scene, which is normalized to 1. Scenes will end up with roughly the same number of values, regardless of the scale of the scene, and regardless of the surface area of the geometries of scene. |
| AbsoluteArea | 1 | Base tessellation density on the absolute area of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. |
| RelativeLength | 2 | Base tessellation density on the relative longest edge of the tessellated attribute, as a fraction of the total diagonal of the scene, which is normalized to 1. This will tessellate scenes the same, regardless of the scale, but scenes with more surface area will end up with a greater number of tessellated values than a scene with a smaller surface area. |
| AbsoluteLength | 3 | Base tessellation density on the absolute longest edge of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. More slivery triangles will be relatively more tessellated than equal area isotropic triangles, since their length to area ratio is higher. |
| UserDefined | 4 | User defined tessellation density. Tessellation levels are defined in a custom field named PrimitiveTessellationLevel. Note that this mode is only available in manual tessellation, and not as part of an automatic tessellation in processors or pipelines. |
Syntax
SetAttributeTessellationDensityMode parameters
GetAttributeTessellationDensityMode return value
Type: EAttributeTessellationDensityMode
Default: RelativeArea
| Key | Value | Comment |
|---|
| RelativeArea | 0 | Base tessellation density on the relative area of the tessellated attribute, as a fraction of the total area of the surface of the scene, which is normalized to 1. Scenes will end up with roughly the same number of values, regardless of the scale of the scene, and regardless of the surface area of the geometries of scene. |
| AbsoluteArea | 1 | Base tessellation density on the absolute area of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. |
| RelativeLength | 2 | Base tessellation density on the relative longest edge of the tessellated attribute, as a fraction of the total diagonal of the scene, which is normalized to 1. This will tessellate scenes the same, regardless of the scale, but scenes with more surface area will end up with a greater number of tessellated values than a scene with a smaller surface area. |
| AbsoluteLength | 3 | Base tessellation density on the absolute longest edge of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. More slivery triangles will be relatively more tessellated than equal area isotropic triangles, since their length to area ratio is higher. |
| UserDefined | 4 | User defined tessellation density. Tessellation levels are defined in a custom field named PrimitiveTessellationLevel. Note that this mode is only available in manual tessellation, and not as part of an automatic tessellation in processors or pipelines. |
Syntax
SetAttributeTessellationDensityMode parameters
GetAttributeTessellationDensityMode return value
Type: EAttributeTessellationDensityMode
Default: RelativeArea
| Key | Value | Comment |
|---|
| EAttributeTessellationDensityMode_RelativeArea | 0 | Base tessellation density on the relative area of the tessellated attribute, as a fraction of the total area of the surface of the scene, which is normalized to 1. Scenes will end up with roughly the same number of values, regardless of the scale of the scene, and regardless of the surface area of the geometries of scene. |
| EAttributeTessellationDensityMode_AbsoluteArea | 1 | Base tessellation density on the absolute area of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. |
| EAttributeTessellationDensityMode_RelativeLength | 2 | Base tessellation density on the relative longest edge of the tessellated attribute, as a fraction of the total diagonal of the scene, which is normalized to 1. This will tessellate scenes the same, regardless of the scale, but scenes with more surface area will end up with a greater number of tessellated values than a scene with a smaller surface area. |
| EAttributeTessellationDensityMode_AbsoluteLength | 3 | Base tessellation density on the absolute longest edge of the tessellated attribute. This will tessellate all attribute values the same size, and tessellated scaled up objects more than the same object scaled down. More slivery triangles will be relatively more tessellated than equal area isotropic triangles, since their length to area ratio is higher. |
| EAttributeTessellationDensityMode_UserDefined | 4 | User defined tessellation density. Tessellation levels are defined in a custom field named PrimitiveTessellationLevel. Note that this mode is only available in manual tessellation, and not as part of an automatic tessellation in processors or pipelines. |
EnableAttributeTessellation
If set to true, attribute tessellation will be calculated on the geometries in the scene.
Syntax
SetEnableAttributeTessellation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to set EnableAttributeTessellation to. |
GetEnableAttributeTessellation return value
Type: bool
Default: false
Syntax
SetEnableAttributeTessellation parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to set EnableAttributeTessellation to. |
GetEnableAttributeTessellation return value
Type: bool
Default: false
Syntax
SetEnableAttributeTessellation parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to set EnableAttributeTessellation to. |
GetEnableAttributeTessellation return value
Type: bool
Default: false
MaxAreaOfTessellatedValue
Setting specific for 'RelativeArea' or 'AbsoluteArea' tessellation density modes. The processor will tessellate a triangle until each value's area is equal or less than the MaxAreaOfTessellatedValue ratio or value, as defined by the mode. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level.
Syntax
SetMaxAreaOfTessellatedValue parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0.000000000001 | 1000000000000 | The value to set MaxAreaOfTessellatedValue to. |
GetMaxAreaOfTessellatedValue return value
Type: real
Default: 1
Syntax
SetMaxAreaOfTessellatedValue parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0.000000000001 | 1000000000000 | The value to set MaxAreaOfTessellatedValue to. |
GetMaxAreaOfTessellatedValue return value
Type: float
Default: 1
Syntax
SetMaxAreaOfTessellatedValue parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0.000000000001 | 1000000000000 | The value to set MaxAreaOfTessellatedValue to. |
GetMaxAreaOfTessellatedValue return value
Type: float
Default: 1
MaxLengthOfTessellatedValue
Setting specific for 'RelativeLengthBased' tessellation density mode. The processor will tessellate the values of a triangle until each value's longest edge is equal or less than the MaxLengthOfTessellatedValue ratio value, as defined by the mode. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level.
Syntax
SetMaxLengthOfTessellatedValue parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0.000000000001 | 1000000000000 | The value to set MaxLengthOfTessellatedValue to. |
GetMaxLengthOfTessellatedValue return value
Type: real
Default: 1
Syntax
SetMaxLengthOfTessellatedValue parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0.000000000001 | 1000000000000 | The value to set MaxLengthOfTessellatedValue to. |
GetMaxLengthOfTessellatedValue return value
Type: float
Default: 1
Syntax
SetMaxLengthOfTessellatedValue parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0.000000000001 | 1000000000000 | The value to set MaxLengthOfTessellatedValue to. |
GetMaxLengthOfTessellatedValue return value
Type: float
Default: 1
MaxTessellationLevel
General tessellation setting. The maximum level of value tessellation allowed for any one triangle.
Syntax
SetMaxTessellationLevel parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | 10 | The value to set MaxTessellationLevel to. |
GetMaxTessellationLevel return value
Type: unsigned int
Default: 5
Syntax
SetMaxTessellationLevel parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | 10 | The value to set MaxTessellationLevel to. |
GetMaxTessellationLevel return value
Type: uint
Default: 5
Syntax
SetMaxTessellationLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | 10 | The value to set MaxTessellationLevel to. |
GetMaxTessellationLevel return value
Type: int
Default: 5
MaxTotalValuesCount
General tessellation setting. The maximum number of values total allowed for one geometry.
Syntax
SetMaxTotalValuesCount parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | INT_MAX | The value to set MaxTotalValuesCount to. |
GetMaxTotalValuesCount return value
Type: unsigned int
Default: INT_MAX
Syntax
SetMaxTotalValuesCount parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | INT_MAX | The value to set MaxTotalValuesCount to. |
GetMaxTotalValuesCount return value
Type: uint
Default: INT_MAX
Syntax
SetMaxTotalValuesCount parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | INT_MAX | The value to set MaxTotalValuesCount to. |
GetMaxTotalValuesCount return value
Type: int
Default: INT_MAX
MinTessellationLevel
General tessellation setting. The minimum level of value tessellation allowed for any one triangle.
Syntax
SetMinTessellationLevel parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | 10 | The value to set MinTessellationLevel to. |
GetMinTessellationLevel return value
Type: unsigned int
Default: 0
Syntax
SetMinTessellationLevel parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | 10 | The value to set MinTessellationLevel to. |
GetMinTessellationLevel return value
Type: uint
Default: 0
Syntax
SetMinTessellationLevel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | 10 | The value to set MinTessellationLevel to. |
GetMinTessellationLevel return value
Type: int
Default: 0
Name
The name of the AttributeTessellationSettings 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
OnlyAllowOneLevelOfDifference
General tessellation setting. If enabled, only allow a difference of one level between neighbor triangles. This is required by some file formats that store attribute data.
Syntax
SetOnlyAllowOneLevelOfDifference parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to set OnlyAllowOneLevelOfDifference to. |
GetOnlyAllowOneLevelOfDifference return value
Type: bool
Default: false
Syntax
SetOnlyAllowOneLevelOfDifference parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to set OnlyAllowOneLevelOfDifference to. |
GetOnlyAllowOneLevelOfDifference return value
Type: bool
Default: false
Syntax
SetOnlyAllowOneLevelOfDifference parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to set OnlyAllowOneLevelOfDifference to. |
GetOnlyAllowOneLevelOfDifference return value
Type: bool
Default: false
The transformation space the evaluation should be done in. Valid values are Global and Local.
Syntax
Type: ETransformationSpace
Default: Global
| Key | Value | Comment |
|---|
| Global | 0 | Transformation in scene global space |
| Local | 1 | Transformation in object/geometry local space |
| Tangent | 2 | Transformation in vertex/triangle tangent space |
| View | 3 | Transformation in view/camera space |
Syntax
Type: ETransformationSpace
Default: Global
| Key | Value | Comment |
|---|
| Global | 0 | Transformation in scene global space |
| Local | 1 | Transformation in object/geometry local space |
| Tangent | 2 | Transformation in vertex/triangle tangent space |
| View | 3 | Transformation in view/camera space |
Syntax
Type: ETransformationSpace
Default: Global
| Key | Value | Comment |
|---|
| ETransformationSpace_Global | 0 | Transformation in scene global space |
| ETransformationSpace_Local | 1 | Transformation in object/geometry local space |
| ETransformationSpace_Tangent | 2 | Transformation in vertex/triangle tangent space |
| ETransformationSpace_View | 3 | Transformation in view/camera space |
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 AttributeTessellationSettings 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 AttributeTessellationSettings 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 AttributeTessellationSettings 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 AttributeTessellationSettings 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 AttributeTessellationSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AttributeTessellationSettings 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 AttributeTessellationSettings 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 AttributeTessellationSettings 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 AttributeTessellationSettings 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 spAttributeTessellationSettings, and if this is the case, returns the object cast into spAttributeTessellationSettings. (Inherited from Object)
