Simplygon 10 Documentation

# 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

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

# EnableAttributeTessellation

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

# Syntax

// Setter
void SetEnableAttributeTessellation( bool value ) const;

// Getter
bool GetEnableAttributeTessellation() const;

# SetEnableAttributeTessellation parameters

Type Name Min Max Description
bool value 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

// Setter
void SetMaxAreaOfTessellatedValue( real value ) const;

// Getter
real GetMaxAreaOfTessellatedValue() const;

# 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

# 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

// Setter
void SetMaxLengthOfTessellatedValue( real value ) const;

// Getter
real GetMaxLengthOfTessellatedValue() const;

# 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

# MaxTessellationLevel

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

# Syntax

// Setter
void SetMaxTessellationLevel( unsigned int value ) const;

// Getter
unsigned int GetMaxTessellationLevel() const;

# 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

# MaxTotalValuesCount

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

# Syntax

// Setter
void SetMaxTotalValuesCount( unsigned int value ) const;

// Getter
unsigned int GetMaxTotalValuesCount() const;

# 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

# MinTessellationLevel

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

# Syntax

// Setter
void SetMinTessellationLevel( unsigned int value ) const;

// Getter
unsigned int GetMinTessellationLevel() const;

# 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

# Name

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

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

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

# GetName return value

Type: spString

# 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

// Setter
void SetOnlyAllowOneLevelOfDifference( bool value ) const;

// Getter
bool GetOnlyAllowOneLevelOfDifference() const;

# SetOnlyAllowOneLevelOfDifference parameters

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

# GetOnlyAllowOneLevelOfDifference return value

Type: bool

Default: false

# TransformationSpace

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

# Syntax

// Setter
void SetTransformationSpace( Simplygon::ETransformationSpace value ) const;

// Getter
Simplygon::ETransformationSpace GetTransformationSpace() const;

# SetTransformationSpace parameters

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

# GetTransformationSpace return value

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

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

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

# Return value

Type: rid

# GetBoolParameter

Get a named parameter boolean value.

# Syntax

bool GetBoolParameter( const char * name ) const;

# Parameters

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

# Return value

Type: bool

# GetClass

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

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetDoubleParameter

Get a named parameter floating point value.

# Syntax

double GetDoubleParameter( const char * name ) const;

# Parameters

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

# Return value

Type: double

# GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

# Syntax

spString GetErrorString() const;

# Parameters

GetErrorString takes no parameters.

# Return value

Type: spString

# GetIntParameter

Get a named parameter integer value.

# Syntax

int GetIntParameter( const char * name ) const;

# Parameters

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

# Return value

Type: int

# GetStringParameter

Get a named parameter string value.

# Syntax

spString GetStringParameter( const char * name ) const;

# Parameters

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

# Return value

Type: spString

# GetUIntParameter

Get a named parameter unsigned integer value.

# Syntax

unsigned int GetUIntParameter( const char * name ) const;

# Parameters

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

# Return value

Type: unsigned int

# IsA

Returns true if AttributeTessellationSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# 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

# IsNull

Returns true if the AttributeTessellationSettings object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the AttributeTessellationSettings object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name 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

bool NonNull() const;

# 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

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId ObserverId is the id returned by AddObserver when the observer was added.

# SetBoolParameter

Set a named parameter boolean value.

# Syntax

bool SetBoolParameter( const char * name , bool value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
bool value New value for parameter.

# Return value

Type: bool

# SetDoubleParameter

Set a named parameter floating point value.

# Syntax

bool SetDoubleParameter( const char * name , double value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
double value New value for parameter.

# Return value

Type: bool

# SetIntParameter

Set a named parameter integer value.

# Syntax

bool SetIntParameter( const char * name , int value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
int value New value for parameter.

# Return value

Type: bool

# SetStringParameter

Set a named parameter string value.

# Syntax

bool SetStringParameter( const char * name , const char * value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
const char * value New value for parameter.

# Return value

Type: bool

# SetUIntParameter

Set a named parameter unsigned integer value.

# Syntax

bool SetUIntParameter( const char * name , unsigned int value ) const;

# Parameters

Type Name Min Max Description
const char * name Parameter name.
unsigned int value 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

void SetValidateParameterNames( bool validate ) const;

# Parameters

Type Name Min Max Description
bool validate Flag indicating if validation is performed or not.

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON() const;

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

# ValidateSettings

Validates the current settings values.

# Syntax

bool ValidateSettings() const;

# 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

static bool IsClassA( const char * type ) const;

# 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

# 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)

# Syntax

static spAttributeTessellationSettings SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: AttributeTessellationSettings

← BillboardCloudSettings →

Terms of Use | Privacy & Cookies | Trademarks
Copyright © 2022 Microsoft