`class` MappingImageSettings

Settings for the Simplygon mapping classes These settings control the properties of the mapping image that will be generated in the current simplification processor (reducer/remesher etc). The mapping image will be used when casting a new texture on the simplified geometry. In the settings object, the user is able to set the dimensions of the image (width/height) as well as whether the LOD should have new texture coordinates and some parameters for how they should be generated and all other settings regarding the mapping image.

Properties

Property	Description
AllowTransparencyMapping	If true, the remeshing processor will allow mapped transparency in the generated mapping image. This allows material casting where gaps filled by the remeshing processor will be cast as transparent.
ApplyNewMaterialIds	If true, and also generating one or more mapping images for material casting, the material IDs in the process geometry will be updated to reflect the new, not yet cast output materials. This means the output scene will be temporarily invalid before the materialtable has been updated to reflect the new changes.
AutomaticTextureSizeMultiplier	Texture dimension length multiplier for the automatic texture size.
ForcePower2Texture	If automatic_texture_size is enabled, then force the texture sizes to be a power of 2.
GenerateMappingImage	If set, the aggregation processor, reduction processor, or remeshing processor will create a mapping image that maps triangles on the reduced geometry back to triangles on the original geometry. The texture is insert into the MappingImage object. The image data will contain two fields: * RidArray, "TriangleIds", TupleSize:1, The id of the triangle * UnsignedShortArray, "BarycentricCoords", TupleSize:2, Items A & B of the barycentric coordinate on the triangle. The user can control the size of the mapped texture using the values MappingTextureWidth and MappingTextureHeight.
GenerateTangents	If true, generates a new tangent space fields at position specified by TexCoordLevel, based on the vertex normals and texture coordinates. Tangent space fields will always be created if missing, and GenerateMappingImage is enabled. If GenerateTexCoords is enabled, new tangents will always be generated.
GenerateTexCoords	If true, generates a new texcoords field at the position specified by TexCoordLevel. Will be ignored and always generate texcoords if none are available in the Geometry if GenerateMappingImage is enabled.
InputMaterialCount	The number of input materials used in the original geometry for mapping to multiple output materials. This needs to be set before you can set any specific in-out material mapping. 0 signifies that no in-out material mapping is used, ie. the process will produce one resulting mapping image.
MaximumLayers	The maximum number of layers in the mapping image. If a remeshed geometry has a lot of transparent triangles, use a higher number to be able to find intersections on the inside of parts of the geometry. This setting only has effect in the remeshing, when running reduction the number of layers is always 1.
Name	The name of the MappingImageSettings object. (Inherited from Object)
OnlyParameterizeInvalidUVs	If enabled, will aggregate all the valid original UVs. If there are invalid original UVs, those parts will receive new parameterized UVs.
OutputMaterialCount	The number of output mapping images that are to be generated. If this is set to more than 1, the material mapping also needs to be set.
ReplaceMappingImages	Whether to replace already existing mapping images in the scene.
TexCoordGeneratorType	Determines which method to use when generating the texture coordinates. Parameterizer generate from scratch based on the geometry. ChartAggregator generate based on the original texture coordinates.
TexCoordLevel	The texture coordinate level used for mapping image and texture generation. If the TexCoordName has been set, the TexCoordLevel is not used.
TexCoordName	The texture coordinate level name used for mapping image and texture generation. If new UVs are created, they will replace the old coordinates in the texture channel with the TexCoordName. If no texture level with this name exists. It will be created. If the TexCoordName is not set, the TexCoordLevel (index) will be used instead.
UseAutomaticTextureSize	The UseAutomaticTextureSize flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.
UseFullRetexturing	If set, all original texcoord sets are replaced by a single new one which will be used for the mapping image. This means the output scene will be temporarily invalid before the materialtable has been updated to reflect the new changes. This flag has no effect on the remeshing, which always does a full retexturing.

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)
GetChartAggregatorSettings	The settings for the chart aggregator.
GetClass	Get the name of the MappingImageSettings 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)
GetInputMaterialSettings	Get the input material settings for the given index.
GetIntParameter	Get a named parameter integer value. (Inherited from SettingsObject)
GetOutputMaterialSettings	Get the output material settings for the given index.
GetParameterizerSettings	The settings for the parameterizer.
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 MappingImageSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the MappingImageSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the MappingImageSettings object is valid. (Inherited from Object)
NonNull	Returns true if the MappingImageSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the MappingImageSettings 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 spMappingImageSettings, and if this is the case, returns the object cast into spMappingImageSettings. (Inherited from Object)

Properties details

AllowTransparencyMapping

If true, the remeshing processor will allow mapped transparency in the generated mapping image. This allows material casting where gaps filled by the remeshing processor will be cast as transparent.

Syntax

cpp

// Setter
void SetAllowTransparencyMapping( bool value ) const;

// Getter
bool GetAllowTransparencyMapping() const;

SetAllowTransparencyMapping parameters

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

GetAllowTransparencyMapping return value

Type: bool

Default: false

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

ApplyNewMaterialIds

If true, and also generating one or more mapping images for material casting, the material IDs in the process geometry will be updated to reflect the new, not yet cast output materials. This means the output scene will be temporarily invalid before the materialtable has been updated to reflect the new changes.

Syntax

cpp

// Setter
void SetApplyNewMaterialIds( bool value ) const;

// Getter
bool GetApplyNewMaterialIds() const;

SetApplyNewMaterialIds parameters

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

GetApplyNewMaterialIds return value

Type: bool

Default: true

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

AutomaticTextureSizeMultiplier

Texture dimension length multiplier for the automatic texture size.

Syntax

cpp

// Setter
void SetAutomaticTextureSizeMultiplier( real value ) const;

// Getter
real GetAutomaticTextureSizeMultiplier() const;

SetAutomaticTextureSizeMultiplier parameters

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

GetAutomaticTextureSizeMultiplier return value

Type: real

Default: 1.0

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

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

ForcePower2Texture

If automatic_texture_size is enabled, then force the texture sizes to be a power of 2.

Syntax

cpp

// Setter
void SetForcePower2Texture( bool value ) const;

// Getter
bool GetForcePower2Texture() const;

SetForcePower2Texture parameters

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

GetForcePower2Texture return value

Type: bool

Default: false

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

GenerateMappingImage

If set, the aggregation processor, reduction processor, or remeshing processor will create a mapping image that maps triangles on the reduced geometry back to triangles on the original geometry. The texture is insert into the MappingImage object. The image data will contain two fields: * RidArray, "TriangleIds", TupleSize:1, The id of the triangle * UnsignedShortArray, "BarycentricCoords", TupleSize:2, Items A & B of the barycentric coordinate on the triangle. The user can control the size of the mapped texture using the values MappingTextureWidth and MappingTextureHeight.

Syntax

cpp

// Setter
void SetGenerateMappingImage( bool value ) const;

// Getter
bool GetGenerateMappingImage() const;

SetGenerateMappingImage parameters

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

GetGenerateMappingImage return value

Type: bool

Default: false

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

GenerateTangents

If true, generates a new tangent space fields at position specified by TexCoordLevel, based on the vertex normals and texture coordinates. Tangent space fields will always be created if missing, and GenerateMappingImage is enabled. If GenerateTexCoords is enabled, new tangents will always be generated.

Syntax

cpp

// Setter
void SetGenerateTangents( bool value ) const;

// Getter
bool GetGenerateTangents() const;

SetGenerateTangents parameters

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

GetGenerateTangents return value

Type: bool

Default: false

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

GenerateTexCoords

If true, generates a new texcoords field at the position specified by TexCoordLevel. Will be ignored and always generate texcoords if none are available in the Geometry if GenerateMappingImage is enabled.

Syntax

cpp

// Setter
void SetGenerateTexCoords( bool value ) const;

// Getter
bool GetGenerateTexCoords() const;

SetGenerateTexCoords parameters

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

GetGenerateTexCoords return value

Type: bool

Default: false

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

InputMaterialCount

The number of input materials used in the original geometry for mapping to multiple output materials. This needs to be set before you can set any specific in-out material mapping. 0 signifies that no in-out material mapping is used, ie. the process will produce one resulting mapping image.

Syntax

cpp

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

// Getter
unsigned int GetInputMaterialCount() const;

SetInputMaterialCount parameters

Type	Name	Min	Max	Description
`unsigned int`	value	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	The number of inputs.

GetInputMaterialCount return value

Type: unsigned int

Default: 0

Type	Name	Min	Max	Description
`uint`	value	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	The number of inputs.

Name	Type	Min	Max	Description
value	`int`	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	The number of inputs.

MaximumLayers

The maximum number of layers in the mapping image. If a remeshed geometry has a lot of transparent triangles, use a higher number to be able to find intersections on the inside of parts of the geometry. This setting only has effect in the remeshing, when running reduction the number of layers is always 1.

Syntax

cpp

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

// Getter
unsigned int GetMaximumLayers() const;

SetMaximumLayers parameters

Type	Name	Min	Max	Description
`unsigned int`	value	0	UINT_MAX	The desired number of layers in the mapping image.

GetMaximumLayers return value

Type: unsigned int

Default: 3

Type	Name	Min	Max	Description
`uint`	value	0	UINT_MAX	The desired number of layers in the mapping image.

Name	Type	Min	Max	Description
value	`int`	0	UINT_MAX	The desired number of layers in the mapping image.

Name

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

Syntax

cpp

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

OnlyParameterizeInvalidUVs

If enabled, will aggregate all the valid original UVs. If there are invalid original UVs, those parts will receive new parameterized UVs.

Syntax

cpp

// Setter
void SetOnlyParameterizeInvalidUVs( bool value ) const;

// Getter
bool GetOnlyParameterizeInvalidUVs() const;

SetOnlyParameterizeInvalidUVs parameters

Type	Name	Min	Max	Description
`bool`	value			The new flag.

GetOnlyParameterizeInvalidUVs return value

Type: bool

Default: false

Name	Type	Min	Max	Description
value	`bool`			The new flag.

OutputMaterialCount

The number of output mapping images that are to be generated. If this is set to more than 1, the material mapping also needs to be set.

Syntax

cpp

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

// Getter
unsigned int GetOutputMaterialCount() const;

SetOutputMaterialCount parameters

Type	Name	Min	Max	Description
`unsigned int`	value	1	SG_MAXIMUM_MAPPING_IMAGE_OUTPUT_MATERIAL_COUNT	The number of outputs.

GetOutputMaterialCount return value

Type: unsigned int

Default: 1

Type	Name	Min	Max	Description
`uint`	value	1	SG_MAXIMUM_MAPPING_IMAGE_OUTPUT_MATERIAL_COUNT	The number of outputs.

Name	Type	Min	Max	Description
value	`int`	1	SG_MAXIMUM_MAPPING_IMAGE_OUTPUT_MATERIAL_COUNT	The number of outputs.

ReplaceMappingImages

Whether to replace already existing mapping images in the scene.

Syntax

cpp

// Setter
void SetReplaceMappingImages( bool value ) const;

// Getter
bool GetReplaceMappingImages() const;

SetReplaceMappingImages parameters

Type	Name	Min	Max	Description
`bool`	value			The new value.

GetReplaceMappingImages return value

Type: bool

Default: true

Name	Type	Min	Max	Description
value	`bool`			The new value.

TexCoordGeneratorType

Determines which method to use when generating the texture coordinates. Parameterizer generate from scratch based on the geometry. ChartAggregator generate based on the original texture coordinates.

Syntax

cpp

// Setter
void SetTexCoordGeneratorType( Simplygon::ETexcoordGeneratorType value ) const;

// Getter
Simplygon::ETexcoordGeneratorType GetTexCoordGeneratorType() const;

SetTexCoordGeneratorType parameters

Type	Name	Min	Max	Description
ETexcoordGeneratorType	value			The TexCoordGeneratorType value to use.

GetTexCoordGeneratorType return value

Type: ETexcoordGeneratorType

Default: Parameterizer

Key	Value	Comment
Parameterizer	0	Texture coordinates are generated from scratch based on the geometry.
ChartAggregator	1	Texture coordinates are generated based on the original texture coordinates.

Syntax

csharp

// Setter
void SetTexCoordGeneratorType(ETexcoordGeneratorType value);

// Getter
ETexcoordGeneratorType GetTexCoordGeneratorType();

SetTexCoordGeneratorType parameters

Type	Name	Min	Max	Description
ETexcoordGeneratorType	value			The TexCoordGeneratorType value to use.

GetTexCoordGeneratorType return value

Type: ETexcoordGeneratorType

Default: Parameterizer

Key	Value	Comment
Parameterizer	0	Texture coordinates are generated from scratch based on the geometry.
ChartAggregator	1	Texture coordinates are generated based on the original texture coordinates.

Syntax

python

# Setter
None SetTexCoordGeneratorType(value: ETexcoordGeneratorType_*)

# Getter
ETexcoordGeneratorType_* GetTexCoordGeneratorType()

SetTexCoordGeneratorType parameters

Name	Type	Min	Max	Description
value	ETexcoordGeneratorType			The TexCoordGeneratorType value to use.

GetTexCoordGeneratorType return value

Type: ETexcoordGeneratorType

Default: Parameterizer

Key	Value	Comment
ETexcoordGeneratorType_Parameterizer	0	Texture coordinates are generated from scratch based on the geometry.
ETexcoordGeneratorType_ChartAggregator	1	Texture coordinates are generated based on the original texture coordinates.

TexCoordLevel

The texture coordinate level used for mapping image and texture generation. If the TexCoordName has been set, the TexCoordLevel is not used.

Syntax

cpp

// Setter
void SetTexCoordLevel( rid value ) const;

// Getter
rid GetTexCoordLevel() const;

SetTexCoordLevel parameters

Type	Name	Min	Max	Description
`rid`	value	-1	INT_MAX	The desired texture coordinate level.

GetTexCoordLevel return value

Type: rid

Default: 0

Type	Name	Min	Max	Description
`int`	value	-1	INT_MAX	The desired texture coordinate level.

TexCoordName

The texture coordinate level name used for mapping image and texture generation. If new UVs are created, they will replace the old coordinates in the texture channel with the TexCoordName. If no texture level with this name exists. It will be created. If the TexCoordName is not set, the TexCoordLevel (index) will be used instead.

Syntax

cpp

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

// Getter
spString GetTexCoordName() const;

SetTexCoordName parameters

Type	Name	Min	Max	Description
`const char *`	value			The TexCoord level name.

GetTexCoordName return value

Type: spString

Default: nullptr

UseAutomaticTextureSize

The UseAutomaticTextureSize flag. If true, then texture sizes will be computed for the reduced mesh depending on its pixel size on screen.

Syntax

cpp

// Setter
void SetUseAutomaticTextureSize( bool value ) const;

// Getter
bool GetUseAutomaticTextureSize() const;

SetUseAutomaticTextureSize parameters

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

GetUseAutomaticTextureSize return value

Type: bool

Default: false

UseFullRetexturing

If set, all original texcoord sets are replaced by a single new one which will be used for the mapping image. This means the output scene will be temporarily invalid before the materialtable has been updated to reflect the new changes. This flag has no effect on the remeshing, which always does a full retexturing.

Syntax

cpp

// Setter
void SetUseFullRetexturing( bool value ) const;

// Getter
bool GetUseFullRetexturing() const;

SetUseFullRetexturing parameters

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

GetUseFullRetexturing return value

Type: bool

Default: false

Methods details

AddObserver

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

Syntax

cpp

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

cpp

bool GetBoolParameter( const char * name ) const;

Parameters

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

Return value

Type: bool

GetChartAggregatorSettings

The settings for the chart aggregator.

Syntax

cpp

spChartAggregatorSettings GetChartAggregatorSettings() const;

Parameters

GetChartAggregatorSettings takes no parameters.

Return value

Type: ChartAggregatorSettings

GetClass

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

Syntax

cpp

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

GetDoubleParameter

Get a named parameter floating point value.

Syntax

cpp

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

cpp

spString GetErrorString() const;

Parameters

GetErrorString takes no parameters.

Return value

Type: spString

GetInputMaterialSettings

Get the input material settings for the given index.

Syntax

cpp

spMappingImageInputMaterialSettings GetInputMaterialSettings( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
`unsigned int`	index	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Input index

Return value

Type: MappingImageInputMaterialSettings

GetIntParameter

Get a named parameter integer value.

Syntax

cpp

int GetIntParameter( const char * name ) const;

Parameters

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

Return value

Type: int

GetOutputMaterialSettings

Get the output material settings for the given index.

Syntax

cpp

spMappingImageOutputMaterialSettings GetOutputMaterialSettings( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
`unsigned int`	index	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Output index

Return value

Type: MappingImageOutputMaterialSettings

GetParameterizerSettings

The settings for the parameterizer.

Syntax

cpp

spParameterizerSettings GetParameterizerSettings() const;

Parameters

GetParameterizerSettings takes no parameters.

Return value

Type: ParameterizerSettings

GetStringParameter

Get a named parameter string value.

Syntax

cpp

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

cpp

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 MappingImageSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

cpp

bool IsA( const char * type ) const;

Parameters

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

Return value

Type: bool

IsNull

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

Syntax

cpp

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

cpp

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 MappingImageSettings object is valid. (Inherited from Object)

Syntax

cpp

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the MappingImageSettings object to the log. (Inherited from Object)

Syntax

cpp

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

RemoveObserver

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

Syntax

cpp

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

cpp

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

cpp

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

cpp

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

cpp

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

cpp

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

cpp

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

cpp

spString ToJSON() const;

Parameters

ToJSON takes no parameters.

Return value

Type: spString

ValidateSettings

Validates the current settings values.

Syntax

cpp

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

cpp

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

Syntax

cpp

static spMappingImageSettings SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: MappingImageSettings

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class MappingImageSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

AllowTransparencyMapping ​

Syntax ​

SetAllowTransparencyMapping parameters ​

GetAllowTransparencyMapping return value ​

ApplyNewMaterialIds ​

Syntax ​

SetApplyNewMaterialIds parameters ​

GetApplyNewMaterialIds return value ​

AutomaticTextureSizeMultiplier ​

Syntax ​

SetAutomaticTextureSizeMultiplier parameters ​

GetAutomaticTextureSizeMultiplier return value ​

ForcePower2Texture ​

Syntax ​

SetForcePower2Texture parameters ​

GetForcePower2Texture return value ​

GenerateMappingImage ​

Syntax ​

SetGenerateMappingImage parameters ​

GetGenerateMappingImage return value ​

GenerateTangents ​

Syntax ​

SetGenerateTangents parameters ​

GetGenerateTangents return value ​

GenerateTexCoords ​

Syntax ​

SetGenerateTexCoords parameters ​

GetGenerateTexCoords return value ​

InputMaterialCount ​

Syntax ​

SetInputMaterialCount parameters ​

GetInputMaterialCount return value ​

MaximumLayers ​

Syntax ​

SetMaximumLayers parameters ​

GetMaximumLayers return value ​

Name ​

Syntax ​

SetName parameters ​

GetName return value ​

`class` MappingImageSettings

Properties

Methods

Static methods

Properties details

AllowTransparencyMapping

Syntax

SetAllowTransparencyMapping parameters

GetAllowTransparencyMapping return value

ApplyNewMaterialIds

Syntax

SetApplyNewMaterialIds parameters

GetApplyNewMaterialIds return value

AutomaticTextureSizeMultiplier

Syntax

SetAutomaticTextureSizeMultiplier parameters

GetAutomaticTextureSizeMultiplier return value

ForcePower2Texture

Syntax

SetForcePower2Texture parameters

GetForcePower2Texture return value

GenerateMappingImage

Syntax

SetGenerateMappingImage parameters

GetGenerateMappingImage return value

GenerateTangents

Syntax

SetGenerateTangents parameters

GetGenerateTangents return value

GenerateTexCoords

Syntax

SetGenerateTexCoords parameters

GetGenerateTexCoords return value

InputMaterialCount

Syntax

SetInputMaterialCount parameters

GetInputMaterialCount return value

MaximumLayers

Syntax

SetMaximumLayers parameters

GetMaximumLayers return value

Name

Syntax

SetName parameters

GetName return value