`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.
OnScreenSize	Setting specific for 'OnScreenSize' tessellation density mode. The processor will tessellate the values of a triangle until each value's longest edge is equal or less than the size of 2 pixels, which makes the area of the tessellated triangles ~1 pixel on screen. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level.
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

cpp

// Setter
void SetAttributeTessellationDensityMode( Simplygon::EAttributeTessellationDensityMode value ) const;

// Getter
Simplygon::EAttributeTessellationDensityMode GetAttributeTessellationDensityMode() const;

SetAttributeTessellationDensityMode parameters

Type	Name	Min	Max	Description
EAttributeTessellationDensityMode	value			The value to set AttributeTessellationDensityMode to.

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.
OnScreenSize	5	Base tessellation density on screen size in pixels, so that the longest edge of the tessellated attribute will be 2 pixels, making the attribute occupy ~1 pixel on screen depending on primitive shape. This is equivalent to the 'AbsoluteLength' density mode, but defined in onscreen pixels rather than scene units.

Syntax

csharp

// Setter
void SetAttributeTessellationDensityMode(EAttributeTessellationDensityMode value);

// Getter
EAttributeTessellationDensityMode GetAttributeTessellationDensityMode();

SetAttributeTessellationDensityMode parameters

Type	Name	Min	Max	Description
EAttributeTessellationDensityMode	value			The value to set AttributeTessellationDensityMode to.

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.
OnScreenSize	5	Base tessellation density on screen size in pixels, so that the longest edge of the tessellated attribute will be 2 pixels, making the attribute occupy ~1 pixel on screen depending on primitive shape. This is equivalent to the 'AbsoluteLength' density mode, but defined in onscreen pixels rather than scene units.

Syntax

python

# Setter
None SetAttributeTessellationDensityMode(value: EAttributeTessellationDensityMode_*)

# Getter
EAttributeTessellationDensityMode_* GetAttributeTessellationDensityMode()

SetAttributeTessellationDensityMode parameters

Name	Type	Min	Max	Description
value	EAttributeTessellationDensityMode			The value to set AttributeTessellationDensityMode to.

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.
EAttributeTessellationDensityMode_OnScreenSize	5	Base tessellation density on screen size in pixels, so that the longest edge of the tessellated attribute will be 2 pixels, making the attribute occupy ~1 pixel on screen depending on primitive shape. This is equivalent to the 'AbsoluteLength' density mode, but defined in onscreen pixels rather than scene units.

EnableAttributeTessellation

If set to true, attribute tessellation will be calculated on the geometries in the scene.

Type	Name	Min	Max	Description
`bool`	value			The value to set EnableAttributeTessellation to.

Type	Name	Min	Max	Description
`bool`	value			The value to set EnableAttributeTessellation to.

Name	Type	Min	Max	Description
value	`bool`			The value to set EnableAttributeTessellation to.

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.

Type	Name	Min	Max	Description
`real`	value	0.000000000001	1000000000000	The value to set MaxAreaOfTessellatedValue to.

Type	Name	Min	Max	Description
`float`	value	0.000000000001	1000000000000	The value to set MaxAreaOfTessellatedValue to.

Name	Type	Min	Max	Description
value	`float`	0.000000000001	1000000000000	The value to set MaxAreaOfTessellatedValue to.

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.

Type	Name	Min	Max	Description
`real`	value	0.000000000001	1000000000000	The value to set MaxLengthOfTessellatedValue to.

Type	Name	Min	Max	Description
`float`	value	0.000000000001	1000000000000	The value to set MaxLengthOfTessellatedValue to.

Name	Type	Min	Max	Description
value	`float`	0.000000000001	1000000000000	The value to set MaxLengthOfTessellatedValue to.

MaxTessellationLevel

General tessellation setting. The maximum level of value tessellation allowed for any one triangle.

Type	Name	Min	Max	Description
`unsigned int`	value	0	10	The value to set MaxTessellationLevel to.

Type	Name	Min	Max	Description
`uint`	value	0	10	The value to set MaxTessellationLevel to.

Name	Type	Min	Max	Description
value	`int`	0	10	The value to set MaxTessellationLevel to.

MaxTotalValuesCount

General tessellation setting. The maximum number of values total allowed for one geometry.

Type	Name	Min	Max	Description
`unsigned int`	value	0	INT_MAX	The value to set MaxTotalValuesCount to.

Type	Name	Min	Max	Description
`uint`	value	0	INT_MAX	The value to set MaxTotalValuesCount to.

Name	Type	Min	Max	Description
value	`int`	0	INT_MAX	The value to set MaxTotalValuesCount to.

MinTessellationLevel

General tessellation setting. The minimum level of value tessellation allowed for any one triangle.

Type	Name	Min	Max	Description
`unsigned int`	value	0	10	The value to set MinTessellationLevel to.

Type	Name	Min	Max	Description
`uint`	value	0	10	The value to set MinTessellationLevel to.

Name	Type	Min	Max	Description
value	`int`	0	10	The value to set MinTessellationLevel to.

Name

The name of the AttributeTessellationSettings object. (Inherited from Object)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the 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.

Type	Name	Min	Max	Description
`bool`	value			The value to set OnlyAllowOneLevelOfDifference to.

Type	Name	Min	Max	Description
`bool`	value			The value to set OnlyAllowOneLevelOfDifference to.

Name	Type	Min	Max	Description
value	`bool`			The value to set OnlyAllowOneLevelOfDifference to.

OnScreenSize

Setting specific for 'OnScreenSize' tessellation density mode. The processor will tessellate the values of a triangle until each value's longest edge is equal or less than the size of 2 pixels, which makes the area of the tessellated triangles ~1 pixel on screen. Note that the tessellation will still adhere to the MaximumTessellationLevel setting, and not tessellate to a higher level.

Type	Name	Min	Max	Description
`unsigned int`	value	20	10000	The value to set OnScreenSize to.

Type	Name	Min	Max	Description
`uint`	value	20	10000	The value to set OnScreenSize to.

Name	Type	Min	Max	Description
value	`int`	20	10000	The value to set OnScreenSize to.

TransformationSpace

The transformation space the evaluation should be done in. Valid values are Global and Local.

Type	Name	Min	Max	Description
ETransformationSpace	value			The value to set TransformationSpace to.

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

Type	Name	Min	Max	Description
ETransformationSpace	value			The value to set TransformationSpace to.

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

Name	Type	Min	Max	Description
value	ETransformationSpace			The value to set TransformationSpace to.

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)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

GetBoolParameter

Get a named parameter boolean value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

GetClass

Get the name of the AttributeTessellationSettings class. (Inherited from Object)

GetDoubleParameter

Get a named parameter floating point value.

Type	Name	Min	Max	Description
`const char *`	name			Parameter name.

Type	Name	Min	Max	Description
`string`	name			Parameter name.

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 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.

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 details

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)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class AttributeTessellationSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

AttributeTessellationDensityMode ​

EnableAttributeTessellation ​

MaxAreaOfTessellatedValue ​

MaxLengthOfTessellatedValue ​

MaxTessellationLevel ​

MaxTotalValuesCount ​

MinTessellationLevel ​

Name ​

OnlyAllowOneLevelOfDifference ​

OnScreenSize ​

`class` AttributeTessellationSettings

Properties

Methods

Static methods

Properties details

AttributeTessellationDensityMode

EnableAttributeTessellation

MaxAreaOfTessellatedValue

MaxLengthOfTessellatedValue

MaxTessellationLevel

MaxTotalValuesCount

MinTessellationLevel

Name

OnlyAllowOneLevelOfDifference

OnScreenSize