Simplygon 9 Documentation

# class VertexColorCasterSettings

VertexColorCasterSettings is the interface for basic vertex color caster settings.

# Properties

Property Description
ColorSpaceEdgeThreshold The color space edge threshold, which will define how many hard color borders there will be.
Dilation The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.
DitherType The type of dithering to use when creating the output object.
FillMode The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.
MaterialChannel The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
OpacityChannel The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used.
OutputColorLevel The OutputColorLevel index.
OutputColorName The OutputColorName string .
OutputDDSCompressionType DDS compression if output format is DDS.
OutputImageFileFormat File format for output texture.
OutputPixelFormat The output pixel format
UseMultisampling Enable or disable multisampling.

# Methods

Method Description
GetClass Get the name of the VertexColorCasterSettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
IsA Returns true if VertexColorCasterSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the VertexColorCasterSettings object is invalid.
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 spVertexColorCasterSettings, and if this is the case, returns the object cast into spVertexColorCasterSettings.

# Properties details

# ColorSpaceEdgeThreshold

The color space edge threshold, which will define how many hard color borders there will be.

# Syntax

// Setter
void SetColorSpaceEdgeThreshold( real value );

// Getter
real GetColorSpaceEdgeThreshold();

# SetColorSpaceEdgeThreshold parameters

Type Name Min Max Description
real value -1 256 The ColorSpaceEdgeThreshold value.

# GetColorSpaceEdgeThreshold return value

Type: real

Default: -1

# Dilation

The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.

# Syntax

// Setter
void SetDilation( unsigned int value );

// Getter
unsigned int GetDilation();

# SetDilation parameters

Type Name Min Max Description
unsigned int value 0 1000 The value to which Dilation will be set.

# GetDilation return value

Type: unsigned int

Default: 0

# DitherType

The type of dithering to use when creating the output object.

# Syntax

// Setter
void SetDitherType( Simplygon::EDitherPatterns value );

// Getter
Simplygon::EDitherPatterns GetDitherType();

# SetDitherType parameters

Type Name Min Max Description
EDitherPatterns value The desired value of the DitherType to use.

# GetDitherType return value

Type: EDitherPatterns

Default: FloydSteinberg

Key Value Comment
NoDither 0 Use no dithering
FloydSteinberg 1 Use Floys-Steinberg dithering
JarvisJudiceNinke 2 Use Jarvis, Judice, and Ninke dithering
Sierra 3 Use Sierra-3 (three row) dithering

# FillMode

The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.

# Syntax

// Setter
void SetFillMode( Simplygon::EAtlasFillMode value );

// Getter
Simplygon::EAtlasFillMode GetFillMode();

# SetFillMode parameters

Type Name Min Max Description
EAtlasFillMode value The mode to which the fill mode will be set.

# GetFillMode return value

Type: EAtlasFillMode

Default: Interpolate

Key Value Comment
Interpolate 0 linearly interpolate the closest samples
NearestNeighbor 1 use the closest available pixel value without interpolation
NoFill 2 Do not fill remaining pixels

# MaterialChannel

The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.

# Syntax

// Setter
void SetMaterialChannel( const char * value );

// Getter
spString GetMaterialChannel();

# SetMaterialChannel parameters

Type Name Min Max Description
const char * value The input material channel name.

# GetMaterialChannel return value

Type: spString

Default: nullptr

# OpacityChannel

The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used.

# Syntax

// Setter
void SetOpacityChannel( const char * value );

// Getter
spString GetOpacityChannel();

# SetOpacityChannel parameters

Type Name Min Max Description
const char * value The desired material channel.

# GetOpacityChannel return value

Type: spString

Default: Opacity

# OutputColorLevel

The OutputColorLevel index.

# Syntax

// Setter
void SetOutputColorLevel( rid value );

// Getter
rid GetOutputColorLevel();

# SetOutputColorLevel parameters

Type Name Min Max Description
rid value The OutputColorLevel index value.

# GetOutputColorLevel return value

Type: rid

Default: -1

# OutputColorName

The OutputColorName string .

# Syntax

// Setter
void SetOutputColorName( const char * value );

// Getter
spString GetOutputColorName();

# SetOutputColorName parameters

Type Name Min Max Description
const char * value The OutputColorLevel index value.

# GetOutputColorName return value

Type: spString

Default: nullptr

# OutputDDSCompressionType

DDS compression if output format is DDS.

# Syntax

// Setter
void SetOutputDDSCompressionType( Simplygon::EDDSCompressionType value );

// Getter
Simplygon::EDDSCompressionType GetOutputDDSCompressionType();

# SetOutputDDSCompressionType parameters

Type Name Min Max Description
EDDSCompressionType value The desired DDS compression type.

# GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key Value Comment
NoCompression -1
BC1 0
BC2 1
BC3 2
BC4 3
BC5 4

# OutputImageFileFormat

File format for output texture.

# Syntax

// Setter
void SetOutputImageFileFormat( Simplygon::EImageOutputFormat value );

// Getter
Simplygon::EImageOutputFormat GetOutputImageFileFormat();

# SetOutputImageFileFormat parameters

Type Name Min Max Description
EImageOutputFormat value The desired file format.

# GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key Value Comment
BMP 0
DDS 1
JPEG 2
PNG 3
TGA 4
TIFF 5

# OutputPixelFormat

The output pixel format

# Syntax

// Setter
void SetOutputPixelFormat( Simplygon::EPixelFormat value );

// Getter
Simplygon::EPixelFormat GetOutputPixelFormat();

# SetOutputPixelFormat parameters

Type Name Min Max Description
EPixelFormat value The desired value to which OutputChannels will be set.

# GetOutputPixelFormat return value

Type: EPixelFormat

Default: R8G8B8A8

Key Value Comment
R8G8B8A8 0 RGBA color channels with 8 bit depth per color channel
R8G8B8 1 RGB color channels with 8 bit depth per color channel
R8 2 R color channel with 8 bit depth per color channel
R16G16B16A16 3 RGBA color channels with 16 bit depth per color channel
R16G16B16 4 RGB color channels with 16 bit depth per color channel
R16 5 R color channel with 16 bit depth per color channel

# UseMultisampling

Enable or disable multisampling.

# Syntax

// Setter
void SetUseMultisampling( bool value );

// Getter
bool GetUseMultisampling();

# SetUseMultisampling parameters

Type Name Min Max Description
bool value The desired value of the flag.

# GetUseMultisampling return value

Type: bool

Default: true

# Methods details

# GetClass

Get the name of the VertexColorCasterSettings class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetErrorString

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

# Syntax

spString GetErrorString();

# Parameters

GetErrorString takes no parameters.

# Return value

Type: spString

# IsA

Returns true if VertexColorCasterSettings is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if VertexColorCasterSettings is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the VertexColorCasterSettings object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# ValidateSettings

Validates the current settings values.

# Syntax

bool ValidateSettings();

# 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

static bool IsClassA( const char * type );

# 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 spVertexColorCasterSettings, and if this is the case, returns the object cast into spVertexColorCasterSettings.

# Syntax

static spVertexColorCasterSettings SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: VertexColorCasterSettings

← VertexWeightSettings →