# `class` MappingImageOutputMaterialSettings

Settings for the Simplygon mapping output.

# Properties

Property	Description
GutterSpace	The minimum number of pixels between charts of the output mapping image.
MultisamplingLevel	The multi-sampling level of the output mapping image. Values 1-8 are accepted.
Name	The name of the MappingImageOutputMaterialSettings object. (Inherited from Object)
TextureHeight	The height of the texture of the output mapping image.
TextureWidth	The width of the texture of the output mapping image.

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

# Properties details

# GutterSpace

The minimum number of pixels between charts of the output mapping image.

# Syntax

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

// Getter
unsigned int GetGutterSpace() const;

# SetGutterSpace parameters

Type	Name	Min	Max	Description
`unsigned int`	value	1	UINT_MAX	The value to which GutterSpace will be set.

# GetGutterSpace return value

Type: unsigned int

Default: 4

Type	Name	Min	Max	Description
`uint`	value	1	UINT_MAX	The value to which GutterSpace will be set.

Name	Type	Min	Max	Description
value	`int`	1	UINT_MAX	The value to which GutterSpace will be set.

# MultisamplingLevel

The multi-sampling level of the output mapping image. Values 1-8 are accepted.

# Syntax

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

// Getter
unsigned int GetMultisamplingLevel() const;

# SetMultisamplingLevel parameters

Type	Name	Min	Max	Description
`unsigned int`	value	1	8	The value to which MultiSamplingLevel will be set.

# GetMultisamplingLevel return value

Type: unsigned int

Default: 2

Type	Name	Min	Max	Description
`uint`	value	1	8	The value to which MultiSamplingLevel will be set.

Name	Type	Min	Max	Description
value	`int`	1	8	The value to which MultiSamplingLevel will be set.

# Name

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

# TextureHeight

The height of the texture of the output mapping image.

# Syntax

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

// Getter
unsigned int GetTextureHeight() const;

# SetTextureHeight parameters

Type	Name	Min	Max	Description
`unsigned int`	value	0	UINT_MAX	The value to which Height will be set.

# GetTextureHeight return value

Type: unsigned int

Default: 1024

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

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

# TextureWidth

The width of the texture of the output mapping image.

# Syntax

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

// Getter
unsigned int GetTextureWidth() const;

# SetTextureWidth parameters

Type	Name	Min	Max	Description
`unsigned int`	value	0	UINT_MAX	The value to which Width will be set.

# GetTextureWidth return value

Type: unsigned int

Default: 1024

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

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

# 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

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

# 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

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

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

# GetClass

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

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

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

# 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

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

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

# 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

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

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

# 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

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

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

# IsA

Returns true if MappingImageOutputMaterialSettings 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 MappingImageOutputMaterialSettings is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if MappingImageOutputMaterialSettings is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if MappingImageOutputMaterialSettings is, or is a descendant of.

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

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

Name	Type	Min	Max	Description
object	Object			Object to compare with.

# NonNull

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

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

Name	Type	Min	Max	Description
observerId	`int`			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

Type	Name	Min	Max	Description
`string`	name			Parameter name.
`bool`	value			New value for parameter.

Name	Type	Min	Max	Description
name	`str`			Parameter name.
value	`bool`			New value for parameter.

# 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

Type	Name	Min	Max	Description
`string`	name			Parameter name.
`double`	value			New value for parameter.

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

# Syntax

static spMappingImageOutputMaterialSettings SafeCast( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

# Return value

Type: MappingImageOutputMaterialSettings

← MappingImageInputMaterialSettings MappingImageSettings →

# class MappingImageOutputMaterialSettings

# Properties

# Methods

# Static methods

# Properties details

# GutterSpace

# Syntax

# SetGutterSpace parameters

# GetGutterSpace return value

# MultisamplingLevel

# Syntax

# SetMultisamplingLevel parameters

# GetMultisamplingLevel return value

# Name

# Syntax

# SetName parameters

# GetName return value

# TextureHeight

# Syntax

# SetTextureHeight parameters

# GetTextureHeight return value

# TextureWidth

# Syntax

# SetTextureWidth parameters

# GetTextureWidth return value

# Methods details

# AddObserver

# Syntax

# Parameters

# Return value

# GetBoolParameter

# Syntax

# Parameters

# Return value

# GetClass

# Syntax

# Parameters

# Return value

# GetDoubleParameter

# Syntax

# Parameters

# Return value

# GetErrorString

# Syntax

# Parameters

# Return value

# GetIntParameter

# Syntax

# Parameters

# Return value

# GetStringParameter

# Syntax

# Parameters

# Return value

# GetUIntParameter

# Syntax

# Parameters

# Return value

# IsA

# Syntax

# Parameters

# Return value

# IsNull

# Syntax

# Parameters

# Return value

# `class` MappingImageOutputMaterialSettings