# `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. Corners more similar than the threshold will be merged. This works similarly to HardEdgeAngle for normals; lower values leads more hard borders between neighboring corner colors, and higher values will give you more shared, smoother, colors. This also impacts data usage when using packed geometry since (more unique colors) == (more vertices). The distance is measured in RGBA space.
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. (Inherited from MaterialCasterSettings)
DitherType	The type of dithering to use when creating the output object. (Inherited from MaterialCasterSettings)
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. (Inherited from MaterialCasterSettings)
MaterialChannel	The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast. (Inherited from MaterialCasterSettings)
Name	The name of the VertexColorCasterSettings object. (Inherited from Object)
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. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property. (Inherited from MaterialCasterSettings)
OpacityChannelComponent	The component in the opacity channel to use as opacity value. (Inherited from MaterialCasterSettings)
OutputColorLevel	The OutputColorLevel index.
OutputColorName	The OutputColorName string .
OutputDDSCompressionType	DDS compression if output format is DDS. (Inherited from MaterialCasterSettings)
OutputImageFileFormat	File format for output texture. (Inherited from MaterialCasterSettings)
OutputPixelFormat	The output pixel format (Inherited from MaterialCasterSettings)
UseMultisampling	Enable or disable multisampling. (Inherited from MaterialCasterSettings)

# 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 VertexColorCasterSettings 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 VertexColorCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the VertexColorCasterSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the VertexColorCasterSettings object is valid. (Inherited from Object)
NonNull	Returns true if the VertexColorCasterSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the VertexColorCasterSettings 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 spVertexColorCasterSettings, and if this is the case, returns the object cast into spVertexColorCasterSettings. (Inherited from Object)

# Properties details

# ColorSpaceEdgeThreshold

The color space edge threshold, which will define how many hard color borders there will be. Corners more similar than the threshold will be merged. This works similarly to HardEdgeAngle for normals; lower values leads more hard borders between neighboring corner colors, and higher values will give you more shared, smoother, colors. This also impacts data usage when using packed geometry since (more unique colors) == (more vertices). The distance is measured in RGBA space.

# Syntax

// Setter
void SetColorSpaceEdgeThreshold( real value ) const;

// Getter
real GetColorSpaceEdgeThreshold() const;

# SetColorSpaceEdgeThreshold parameters

Type	Name	Min	Max	Description
`real`	value	0	REAL_MAX	The ColorSpaceEdgeThreshold value.

# GetColorSpaceEdgeThreshold return value

Type: real

Default: 2

Type	Name	Min	Max	Description
`float`	value	0	REAL_MAX	The ColorSpaceEdgeThreshold value.

Name	Type	Min	Max	Description
value	`float`	0	REAL_MAX	The ColorSpaceEdgeThreshold value.

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

// Getter
unsigned int GetDilation() const;

# 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: 10

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

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

# DitherType

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

# Syntax

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

// Getter
Simplygon::EDitherPatterns GetDitherType() const;

# 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 Floyd-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

# Syntax

// Setter
void SetDitherType(EDitherPatterns value);

// Getter
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 Floyd-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

# Syntax

# Setter
None SetDitherType(value: EDitherPatterns_*)

# Getter
EDitherPatterns_* GetDitherType()

# SetDitherType parameters

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

# GetDitherType return value

Type: EDitherPatterns

Default: FloydSteinberg

Key	Value	Comment
EDitherPatterns_NoDither	0	Use no dithering
EDitherPatterns_FloydSteinberg	1	Use Floyd-Steinberg dithering
EDitherPatterns_JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
EDitherPatterns_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 ) const;

// Getter
Simplygon::EAtlasFillMode GetFillMode() const;

# 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

# Syntax

// Setter
void SetFillMode(EAtlasFillMode value);

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

# Syntax

# Setter
None SetFillMode(value: EAtlasFillMode_*)

# Getter
EAtlasFillMode_* GetFillMode()

# SetFillMode parameters

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

# GetFillMode return value

Type: EAtlasFillMode

Default: Interpolate

Key	Value	Comment
EAtlasFillMode_Interpolate	0	linearly interpolate the closest samples
EAtlasFillMode_NearestNeighbor	1	use the closest available pixel value without interpolation
EAtlasFillMode_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 ) const;

// Getter
spString GetMaterialChannel() const;

# SetMaterialChannel parameters

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

# GetMaterialChannel return value

Type: spString

Default: nullptr

Type	Name	Min	Max	Description
`string`	value			The input material channel name.

Name	Type	Min	Max	Description
value	`str`			The input material channel name.

# Name

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

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

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

# 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. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property.

# Syntax

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

// Getter
spString GetOpacityChannel() const;

# SetOpacityChannel parameters

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

# GetOpacityChannel return value

Type: spString

Default: Opacity

Type	Name	Min	Max	Description
`string`	value			The desired material channel.

Name	Type	Min	Max	Description
value	`str`			The desired material channel.

# OpacityChannelComponent

The component in the opacity channel to use as opacity value.

# Syntax

// Setter
void SetOpacityChannelComponent( Simplygon::EColorComponent value ) const;

// Getter
Simplygon::EColorComponent GetOpacityChannelComponent() const;

# SetOpacityChannelComponent parameters

Type	Name	Min	Max	Description
EColorComponent	value			The desired component in the opacity material channel to use as opacity value.

# GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
Red	0	Red color component
Green	1	Green color component
Blue	2	Blue color component
Alpha	3	Alpha color component

# Syntax

// Setter
void SetOpacityChannelComponent(EColorComponent value);

// Getter
EColorComponent GetOpacityChannelComponent();

# SetOpacityChannelComponent parameters

Type	Name	Min	Max	Description
EColorComponent	value			The desired component in the opacity material channel to use as opacity value.

# GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
Red	0	Red color component
Green	1	Green color component
Blue	2	Blue color component
Alpha	3	Alpha color component

# Syntax

# Setter
None SetOpacityChannelComponent(value: EColorComponent_*)

# Getter
EColorComponent_* GetOpacityChannelComponent()

# SetOpacityChannelComponent parameters

Name	Type	Min	Max	Description
value	EColorComponent			The desired component in the opacity material channel to use as opacity value.

# GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
EColorComponent_Red	0	Red color component
EColorComponent_Green	1	Green color component
EColorComponent_Blue	2	Blue color component
EColorComponent_Alpha	3	Alpha color component

# OutputColorLevel

The OutputColorLevel index.

# Syntax

// Setter
void SetOutputColorLevel( rid value ) const;

// Getter
rid GetOutputColorLevel() const;

# SetOutputColorLevel parameters

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

# GetOutputColorLevel return value

Type: rid

Default: -1

Type	Name	Min	Max	Description
`int`	value			The OutputColorLevel index value.

Name	Type	Min	Max	Description
value	`int`			The OutputColorLevel index value.

# OutputColorName

The OutputColorName string .

# Syntax

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

// Getter
spString GetOutputColorName() const;

# SetOutputColorName parameters

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

# GetOutputColorName return value

Type: spString

Default: nullptr

Type	Name	Min	Max	Description
`string`	value			The OutputColorLevel index value.

Name	Type	Min	Max	Description
value	`str`			The OutputColorLevel index value.

# OutputDDSCompressionType

DDS compression if output format is DDS.

# Syntax

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

// Getter
Simplygon::EDDSCompressionType GetOutputDDSCompressionType() const;

# 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

# Syntax

// Setter
void SetOutputDDSCompressionType(EDDSCompressionType value);

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

# Syntax

# Setter
None SetOutputDDSCompressionType(value: EDDSCompressionType_*)

# Getter
EDDSCompressionType_* GetOutputDDSCompressionType()

# SetOutputDDSCompressionType parameters

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

# GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key	Value	Comment
EDDSCompressionType_NoCompression	-1
EDDSCompressionType_BC1	0
EDDSCompressionType_BC2	1
EDDSCompressionType_BC3	2
EDDSCompressionType_BC4	3
EDDSCompressionType_BC5	4

# OutputImageFileFormat

File format for output texture.

# Syntax

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

// Getter
Simplygon::EImageOutputFormat GetOutputImageFileFormat() const;

# 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
EXR	8

# Syntax

// Setter
void SetOutputImageFileFormat(EImageOutputFormat value);

// Getter
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
EXR	8

# Syntax

# Setter
None SetOutputImageFileFormat(value: EImageOutputFormat_*)

# Getter
EImageOutputFormat_* GetOutputImageFileFormat()

# SetOutputImageFileFormat parameters

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

# GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key	Value	Comment
EImageOutputFormat_BMP	0
EImageOutputFormat_DDS	1
EImageOutputFormat_JPEG	2
EImageOutputFormat_PNG	3
EImageOutputFormat_TGA	4
EImageOutputFormat_TIFF	5
EImageOutputFormat_EXR	8

# OutputPixelFormat

The output pixel format

# Syntax

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

// Getter
Simplygon::EPixelFormat GetOutputPixelFormat() const;

# 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
R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

# Syntax

// Setter
void SetOutputPixelFormat(EPixelFormat value);

// Getter
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
R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

# Syntax

# Setter
None SetOutputPixelFormat(value: EPixelFormat_*)

# Getter
EPixelFormat_* GetOutputPixelFormat()

# SetOutputPixelFormat parameters

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

# GetOutputPixelFormat return value

Type: EPixelFormat

Default: R8G8B8A8

Key	Value	Comment
EPixelFormat_R8G8B8A8	0	RGBA color channels with 8 bit depth per color channel
EPixelFormat_R8G8B8	1	RGB color channels with 8 bit depth per color channel
EPixelFormat_R8	2	R color channel with 8 bit depth per color channel
EPixelFormat_R16G16B16A16	3	RGBA color channels with 16 bit depth per color channel
EPixelFormat_R16G16B16	4	RGB color channels with 16 bit depth per color channel
EPixelFormat_R16	5	R color channel with 16 bit depth per color channel
EPixelFormat_R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

# UseMultisampling

Enable or disable multisampling.

# Syntax

// Setter
void SetUseMultisampling( bool value ) const;

// Getter
bool GetUseMultisampling() const;

# SetUseMultisampling parameters

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

# GetUseMultisampling return value

Type: bool

Default: true

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

# Return value

Type: bool

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

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

# Syntax

static spVertexColorCasterSettings SafeCast( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

# Return value

Type: VertexColorCasterSettings

← RepairSettings VertexWeightSettings →

# class VertexColorCasterSettings

# Properties

# Methods

# Static methods

# Properties details

# ColorSpaceEdgeThreshold

# Syntax

# SetColorSpaceEdgeThreshold parameters

# GetColorSpaceEdgeThreshold return value

# Dilation

# Syntax

# SetDilation parameters

# GetDilation return value

# DitherType

# Syntax

# SetDitherType parameters

# GetDitherType return value

# FillMode

# Syntax

# SetFillMode parameters

# GetFillMode return value

# MaterialChannel

# Syntax

# SetMaterialChannel parameters

# GetMaterialChannel return value

# Name

# Syntax

# SetName parameters

# GetName return value

# OpacityChannel

# Syntax

# SetOpacityChannel parameters

# GetOpacityChannel return value

# OpacityChannelComponent

# Syntax

# SetOpacityChannelComponent parameters

# GetOpacityChannelComponent return value

# OutputColorLevel

# Syntax

# SetOutputColorLevel parameters

# GetOutputColorLevel return value

# OutputColorName

# Syntax

# SetOutputColorName parameters

# GetOutputColorName return value

# OutputDDSCompressionType

# Syntax

# SetOutputDDSCompressionType parameters

# GetOutputDDSCompressionType return value

# OutputImageFileFormat

# Syntax

# SetOutputImageFileFormat parameters

# GetOutputImageFileFormat return value

# OutputPixelFormat

# Syntax

# SetOutputPixelFormat parameters

# GetOutputPixelFormat return value

# UseMultisampling

# Syntax

# SetUseMultisampling parameters

# GetUseMultisampling return value

# Methods details

# AddObserver

# Syntax

# Parameters

# Return value

# `class` VertexColorCasterSettings