Simplygon 10 Documentation

# class AttributeTessellationSamplingSettings

Settings for sampling tessellated attributes from input data, either direct injected or through material casting.

# Properties

Property Description
AttributeFormat The attribute data format (Setting only applicable if also allocating the attribute while sampling/injecting data)
BlendOperation Blend operation. How to interpret multiple samples when inserting into the final sample.
Name The name of the AttributeTessellationSamplingSettings object. (Inherited from Object)
SourceMaterialId Id of the source material in the materials list to sample. To sample all materials, set to -1.
SupersamplingCount The number of times to super-sample into the tessellated attribute.

# Methods

Method Description
AddObserver Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
FlipChannel Flips/negates the values on one channel (0-3)
GetBoolParameter Get a named parameter boolean value. (Inherited from SettingsObject)
GetChannelBias Gets the current bias value for one channel (0-3)
GetClass Get the name of the AttributeTessellationSamplingSettings 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)
GetTransformationToMatrix4x4 Copy the transformation kernel data to a 4x4 matrix
GetUIntParameter Get a named parameter unsigned integer value. (Inherited from SettingsObject)
IsA Returns true if AttributeTessellationSamplingSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the AttributeTessellationSamplingSettings object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
NonNull Returns true if the AttributeTessellationSamplingSettings object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the AttributeTessellationSamplingSettings object to the log. (Inherited from Object)
RemoveObserver Removes a previously added observer object. (Inherited from Object)
ResetTransformation Set the sample transformation to pass the data unmodified.
SetBoolParameter Set a named parameter boolean value. (Inherited from SettingsObject)
SetChannelBias Sets the bias value for one channel (0-3)
SetChannelSamplingKernel Sets the sampling kernel on one channel (0-3)
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)
SetTransformationFromMatrix4x4 Copy the transformation kernel data from a 4x4 matrix
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 spAttributeTessellationSamplingSettings, and if this is the case, returns the object cast into spAttributeTessellationSamplingSettings. (Inherited from Object)

# Properties details

# AttributeFormat

The attribute data format (Setting only applicable if also allocating the attribute while sampling/injecting data)

# Syntax

// Setter
void SetAttributeFormat( Simplygon::EAttributeFormat value ) const;

// Getter
Simplygon::EAttributeFormat GetAttributeFormat() const;

# SetAttributeFormat parameters

Type Name Min Max Description
EAttributeFormat value The value to set AttributeFormat to.

# GetAttributeFormat return value

Type: EAttributeFormat

Default: U8

Key Value Comment
U8 4097 1 unsigned 8-bit value.
S8 4353 1 signed 8-bit value.
U8vec2 8193 2 unsigned 8-bit values.
S8vec2 8449 2 signed 8-bit values.
U8vec3 12289 3 unsigned 8-bit values.
S8vec3 12545 3 signed 8-bit values.
U8vec4 16385 4 unsigned 8-bit values.
S8vec4 16641 4 signed 8-bit values.
U16 4098 1 unsigned 16-bit value.
S16 4354 1 signed 16-bit value.
U16vec2 8194 2 unsigned 16-bit values.
S16vec2 8450 2 signed 16-bit values.
U16vec3 12290 3 unsigned 16-bit values.
S16vec3 12546 3 signed 16-bit values.
U16vec4 16386 4 unsigned 16-bit values.
S16vec4 16642 4 signed 16-bit values.
U32 4100 1 unsigned 32-bit value.
S32 4356 1 signed 32-bit value.
F32 4612 1 floating-point 32-bit value.
U32vec2 8196 2 unsigned 32-bit values.
S32vec2 8452 2 signed 32-bit values.
F32vec2 8708 2 floating-point 32-bit values.
U32vec3 12292 3 unsigned 32-bit values.
S32vec3 12548 3 signed 32-bit values.
F32vec3 12804 3 floating-point 32-bit values.
U32vec4 16388 4 unsigned 32-bit values.
S32vec4 16644 4 signed 32-bit values.
F32vec4 16900 4 floating-point 32-bit values.
U64 4104 1 unsigned 64-bit value.
S64 4360 1 signed 64-bit value.
F64 4616 1 floating-point 64-bit value.
F64vec2 8712 2 floating-point 64-bit values.
F64vec3 12808 3 floating-point 64-bit values.
F64vec4 16904 4 floating-point 64-bit values.

# BlendOperation

Blend operation. How to interpret multiple samples when inserting into the final sample.

# Syntax

// Setter
void SetBlendOperation( Simplygon::EBlendOperation value ) const;

// Getter
Simplygon::EBlendOperation GetBlendOperation() const;

# SetBlendOperation parameters

Type Name Min Max Description
EBlendOperation value The value to set BlendOperation to.

# GetBlendOperation return value

Type: EBlendOperation

Default: Mean

Key Value Comment
Mean 0 Use the mean of all samples
Min 1 Keep the minimum sample
Max 2 Keep the maximum sample

# Name

The name of the AttributeTessellationSamplingSettings 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

# SourceMaterialId

Id of the source material in the materials list to sample. To sample all materials, set to -1.

# Syntax

// Setter
void SetSourceMaterialId( rid value ) const;

// Getter
rid GetSourceMaterialId() const;

# SetSourceMaterialId parameters

Type Name Min Max Description
rid value The value to set SourceMaterialId to.

# GetSourceMaterialId return value

Type: rid

Default: -1

# SupersamplingCount

The number of times to super-sample into the tessellated attribute.

# Syntax

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

// Getter
unsigned int GetSupersamplingCount() const;

# SetSupersamplingCount parameters

Type Name Min Max Description
unsigned int value 1 The value to set SupersamplingCount to.

# GetSupersamplingCount return value

Type: unsigned int

Default: 1

# 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

# FlipChannel

Flips/negates the values on one channel (0-3)

# Syntax

void FlipChannel( unsigned int channelIndex ) const;

# Parameters

Type Name Min Max Description
unsigned int channelIndex 0 3 The channel to flip (0-3)

# 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

# GetChannelBias

Gets the current bias value for one channel (0-3)

# Syntax

real GetChannelBias( unsigned int channelIndex ) const;

# Parameters

Type Name Min Max Description
unsigned int channelIndex 0 3 The channel to modify bias value for

# Return value

Type: real

Default: 0

# GetClass

Get the name of the AttributeTessellationSamplingSettings 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

# GetTransformationToMatrix4x4

Copy the transformation kernel data to a 4x4 matrix

# Syntax

void GetTransformationToMatrix4x4( const spMatrix4x4 & destMatrix ) const;

# Parameters

Type Name Min Max Description
Matrix4x4 destMatrix The matrix to copy the transformation kernel to.

# 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 AttributeTessellationSamplingSettings 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 AttributeTessellationSamplingSettings is, or is a descendant of.

# Return value

Type: bool

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the AttributeTessellationSamplingSettings 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 AttributeTessellationSamplingSettings 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 AttributeTessellationSamplingSettings 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.

# ResetTransformation

Set the sample transformation to pass the data unmodified.

# Syntax

void ResetTransformation() const;

# Parameters

Type Name Min Max Description

# 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

# SetChannelBias

Sets the bias value for one channel (0-3)

# Syntax

void SetChannelBias( unsigned int channelIndex , real biasValue ) const;

# Parameters

Type Name Min Max Description
unsigned int channelIndex 0 3 The channel to modify bias value for
real biasValue The bias value to set in the channel

# SetChannelSamplingKernel

Sets the sampling kernel on one channel (0-3)

# Syntax

void SetChannelSamplingKernel( unsigned int channelIndex , real bias , real input0 , real input1 , real input2 , real input3 ) const;

# Parameters

Type Name Min Max Description
unsigned int channelIndex 0 3 The channel to flip (0-3)
real bias The bias value, which is added to the final result.
real input0 Input 0 (red / x)
real input1 Input 1 (green / y)
real input2 Input 2 (blue / z)
real input3 Input 3 (alpha / w)

# 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

# SetTransformationFromMatrix4x4

Copy the transformation kernel data from a 4x4 matrix

# Syntax

void SetTransformationFromMatrix4x4( const spMatrix4x4 & srcMatrix ) const;

# Parameters

Type Name Min Max Description
Matrix4x4 srcMatrix The matrix to copy the transformation kernel from.

# 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 spAttributeTessellationSamplingSettings, and if this is the case, returns the object cast into spAttributeTessellationSamplingSettings. (Inherited from Object)

# Syntax

static spAttributeTessellationSamplingSettings SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: AttributeTessellationSamplingSettings

← AttributeTessellationSettings →

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