class MappingImageSettings

Settings for the Simplygon mapping classes. These settings control the mapping image generated by the current simplification processor (reducer/remesher etc.), including its dimensions and the generation of output texture coordinates and tangent space on the processed geometry. The mapping image is used when casting new textures onto that geometry. TexCoordName and TexCoordLevel select the destination texture coordinate field; they do not select the original geometry fields used to evaluate the input materials. Input material interpretation is defined by the source MaterialTable, its materials and shading networks, and the referenced textures in the source TextureTable. For example, each source ShadingTextureNode selects its input UV field through its own TexCoordName or TexCoordLevel. ChartAggregatorSettings::OriginalTexCoordName and OriginalTexCoordLevel select charts to reuse for UV generation, not the fields used to evaluate the input materials.

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 new tangent and bitangent fields based on the vertex normals and the texture coordinate field selected by TexCoordName, or by TexCoordLevel if TexCoordName is null or empty. The fields are stored at the same level as the selected texture coordinates and are retrieved with GeometryData::GetTangents(level) and GeometryData::GetBitangents(level). Their alternative names are null; TexCoordName is not assigned to them. If only the texture coordinate alternative name is known, first resolve its level with GeometryData::GetNamedTexCoordsIndex(name), check that the result is not -1, and use that level to retrieve both fields. 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 new texture coordinates in the field selected by TexCoordName, or by TexCoordLevel if TexCoordName is null or empty. Will be ignored and always generate texcoords if none are available in the Geometry if GenerateMappingImage is enabled. Generated tangent and bitangent fields use the same level as the selected texture coordinate field, but do not inherit its alternative name. See GenerateTangents and TexCoordName.
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.
OverrideTangentCalculator	If true, overrides the DefaultTangentCalculatorType and TangentCalculatorInvertV global setting, and uses the tangent calculator type defined by the TangentCalculatorType and TangentCalculatorInvertV settings in this object. If false, TangentCalculatorType is ignored and DefaultTangentCalculatorType is used to define the calculator type. Note that this setting is ignored unless GenerateTangents is set to true.
ReplaceMappingImages	Whether to replace already existing mapping images in the scene.
TangentCalculatorInvertV	If true, will invert the bitangent in the output. Note that this setting is ignored unless GenerateTangents and OverrideTangentCalculator are both set to true.
TangentCalculatorType	The tangent calculator type to use when generating tangents for the mapping image data. Note that this setting is ignored unless GenerateTangents and OverrideTangentCalculator are both set to true.
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 destination texture coordinate level used for mapping image and output texture generation. This selects the field on the processed geometry, not the original UV field used to sample input material textures; configure that separately in the source material's ShadingTextureNode. Generated tangent and bitangent fields use this same level. If TexCoordName is non-empty, TexCoordLevel is ignored, including for tangent generation. In that case, resolve the actual output level with GeometryData::GetNamedTexCoordsIndex(TexCoordName) rather than assuming it equals this setting.
TexCoordName	The alternative name of the destination texture coordinate field used for mapping image and output texture generation. This selects the field on the processed geometry, not the original UV field used to sample input material textures; configure that separately in the source material's ShadingTextureNode. A non-empty name takes precedence over TexCoordLevel. If new UVs are created, they replace the coordinates in the field with this alternative name. If no such field exists, it is created at the first available texture coordinate level, not necessarily at TexCoordLevel. If TexCoordName is null or empty, TexCoordLevel is used instead. Generated tangent and bitangent fields use the actual level of this texture coordinate field, but their alternative names are null. To retrieve them by the texture coordinate name, call GeometryData::GetNamedTexCoordsIndex(name), check that the result is not -1, then call GetTangents(level) and GetBitangents(level). GetNamedTangents(name) and GetNamedBitangents(name) do not resolve a texture coordinate alternative name.
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

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

Syntax

// Setter
void SetAllowTransparencyMapping(bool value);

// Getter
bool GetAllowTransparencyMapping();

SetAllowTransparencyMapping parameters

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

GetAllowTransparencyMapping return value

Type: bool

Default: false

Syntax

# Setter
None SetAllowTransparencyMapping(value: bool)

# Getter
bool GetAllowTransparencyMapping()

SetAllowTransparencyMapping parameters

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

GetAllowTransparencyMapping return value

Type: bool

Default: false

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

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

Syntax

// Setter
void SetApplyNewMaterialIds(bool value);

// Getter
bool GetApplyNewMaterialIds();

SetApplyNewMaterialIds parameters

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

GetApplyNewMaterialIds return value

Type: bool

Default: true

Syntax

# Setter
None SetApplyNewMaterialIds(value: bool)

# Getter
bool GetApplyNewMaterialIds()

SetApplyNewMaterialIds parameters

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

GetApplyNewMaterialIds return value

Type: bool

Default: true

AutomaticTextureSizeMultiplier

Texture dimension length multiplier for the automatic texture size.

Syntax

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

Syntax

// Setter
void SetAutomaticTextureSizeMultiplier(float value);

// Getter
float GetAutomaticTextureSizeMultiplier();

SetAutomaticTextureSizeMultiplier parameters

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

GetAutomaticTextureSizeMultiplier return value

Type: float

Default: 1.0

Syntax

# Setter
None SetAutomaticTextureSizeMultiplier(value: float)

# Getter
float GetAutomaticTextureSizeMultiplier()

SetAutomaticTextureSizeMultiplier parameters

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

GetAutomaticTextureSizeMultiplier return value

Type: float

Default: 1.0

ForcePower2Texture

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

Syntax

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

Syntax

// Setter
void SetForcePower2Texture(bool value);

// Getter
bool GetForcePower2Texture();

SetForcePower2Texture parameters

Type	Name	Min	Max	Description
bool	value			The desired flag.

GetForcePower2Texture return value

Type: bool

Default: false

Syntax

# Setter
None SetForcePower2Texture(value: bool)

# Getter
bool GetForcePower2Texture()

SetForcePower2Texture parameters

Name	Type	Min	Max	Description
value	bool			The desired flag.

GetForcePower2Texture return value

Type: bool

Default: false

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

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

Syntax

// Setter
void SetGenerateMappingImage(bool value);

// Getter
bool GetGenerateMappingImage();

SetGenerateMappingImage parameters

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

GetGenerateMappingImage return value

Type: bool

Default: false

Syntax

# Setter
None SetGenerateMappingImage(value: bool)

# Getter
bool GetGenerateMappingImage()

SetGenerateMappingImage parameters

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

GetGenerateMappingImage return value

Type: bool

Default: false

GenerateTangents

If true, generates new tangent and bitangent fields based on the vertex normals and the texture coordinate field selected by TexCoordName, or by TexCoordLevel if TexCoordName is null or empty. The fields are stored at the same level as the selected texture coordinates and are retrieved with GeometryData::GetTangents(level) and GeometryData::GetBitangents(level). Their alternative names are null; TexCoordName is not assigned to them. If only the texture coordinate alternative name is known, first resolve its level with GeometryData::GetNamedTexCoordsIndex(name), check that the result is not -1, and use that level to retrieve both fields. Tangent space fields will always be created if missing, and GenerateMappingImage is enabled. If GenerateTexCoords is enabled, new tangents will always be generated.

Syntax

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

Syntax

// Setter
void SetGenerateTangents(bool value);

// Getter
bool GetGenerateTangents();

SetGenerateTangents parameters

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

GetGenerateTangents return value

Type: bool

Default: false

Syntax

# Setter
None SetGenerateTangents(value: bool)

# Getter
bool GetGenerateTangents()

SetGenerateTangents parameters

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

GetGenerateTangents return value

Type: bool

Default: false

GenerateTexCoords

If true, generates new texture coordinates in the field selected by TexCoordName, or by TexCoordLevel if TexCoordName is null or empty. Will be ignored and always generate texcoords if none are available in the Geometry if GenerateMappingImage is enabled. Generated tangent and bitangent fields use the same level as the selected texture coordinate field, but do not inherit its alternative name. See GenerateTangents and TexCoordName.

Syntax

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

Syntax

// Setter
void SetGenerateTexCoords(bool value);

// Getter
bool GetGenerateTexCoords();

SetGenerateTexCoords parameters

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

GetGenerateTexCoords return value

Type: bool

Default: false

Syntax

# Setter
None SetGenerateTexCoords(value: bool)

# Getter
bool GetGenerateTexCoords()

SetGenerateTexCoords parameters

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

GetGenerateTexCoords return value

Type: bool

Default: false

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

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

Syntax

// Setter
void SetInputMaterialCount(uint value);

// Getter
uint GetInputMaterialCount();

SetInputMaterialCount parameters

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

GetInputMaterialCount return value

Type: uint

Default: 0

Syntax

# Setter
None SetInputMaterialCount(value: int)

# Getter
int GetInputMaterialCount()

SetInputMaterialCount parameters

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

GetInputMaterialCount return value

Type: int

Default: 0

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

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

Syntax

// Setter
void SetMaximumLayers(uint value);

// Getter
uint GetMaximumLayers();

SetMaximumLayers parameters

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

GetMaximumLayers return value

Type: uint

Default: 3

Syntax

# Setter
None SetMaximumLayers(value: int)

# Getter
int GetMaximumLayers()

SetMaximumLayers parameters

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

GetMaximumLayers return value

Type: int

Default: 3

Name

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

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

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

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

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

GetName return value

Type: str

OnlyParameterizeInvalidUVs

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

Syntax

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

Syntax

// Setter
void SetOnlyParameterizeInvalidUVs(bool value);

// Getter
bool GetOnlyParameterizeInvalidUVs();

SetOnlyParameterizeInvalidUVs parameters

Type	Name	Min	Max	Description
bool	value			The new flag.

GetOnlyParameterizeInvalidUVs return value

Type: bool

Default: false

Syntax

# Setter
None SetOnlyParameterizeInvalidUVs(value: bool)

# Getter
bool GetOnlyParameterizeInvalidUVs()

SetOnlyParameterizeInvalidUVs parameters

Name	Type	Min	Max	Description
value	bool			The new flag.

GetOnlyParameterizeInvalidUVs return value

Type: bool

Default: false

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

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

Syntax

// Setter
void SetOutputMaterialCount(uint value);

// Getter
uint GetOutputMaterialCount();

SetOutputMaterialCount parameters

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

GetOutputMaterialCount return value

Type: uint

Default: 1

Syntax

# Setter
None SetOutputMaterialCount(value: int)

# Getter
int GetOutputMaterialCount()

SetOutputMaterialCount parameters

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

GetOutputMaterialCount return value

Type: int

Default: 1

OverrideTangentCalculator

If true, overrides the DefaultTangentCalculatorType and TangentCalculatorInvertV global setting, and uses the tangent calculator type defined by the TangentCalculatorType and TangentCalculatorInvertV settings in this object. If false, TangentCalculatorType is ignored and DefaultTangentCalculatorType is used to define the calculator type. Note that this setting is ignored unless GenerateTangents is set to true.

Syntax

// Setter
void SetOverrideTangentCalculator( bool value ) const;

// Getter
bool GetOverrideTangentCalculator() const;

SetOverrideTangentCalculator parameters

Type	Name	Min	Max	Description
bool	value			The desired OverrideTangentCalculatorType value.

GetOverrideTangentCalculator return value

Type: bool

Default: false

Syntax

// Setter
void SetOverrideTangentCalculator(bool value);

// Getter
bool GetOverrideTangentCalculator();

SetOverrideTangentCalculator parameters

Type	Name	Min	Max	Description
bool	value			The desired OverrideTangentCalculatorType value.

GetOverrideTangentCalculator return value

Type: bool

Default: false

Syntax

# Setter
None SetOverrideTangentCalculator(value: bool)

# Getter
bool GetOverrideTangentCalculator()

SetOverrideTangentCalculator parameters

Name	Type	Min	Max	Description
value	bool			The desired OverrideTangentCalculatorType value.

GetOverrideTangentCalculator return value

Type: bool

Default: false

ReplaceMappingImages

Whether to replace already existing mapping images in the scene.

Syntax

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

Syntax

// Setter
void SetReplaceMappingImages(bool value);

// Getter
bool GetReplaceMappingImages();

SetReplaceMappingImages parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetReplaceMappingImages return value

Type: bool

Default: true

Syntax

# Setter
None SetReplaceMappingImages(value: bool)

# Getter
bool GetReplaceMappingImages()

SetReplaceMappingImages parameters

Name	Type	Min	Max	Description
value	bool			The new value.

GetReplaceMappingImages return value

Type: bool

Default: true

TangentCalculatorInvertV

If true, will invert the bitangent in the output. Note that this setting is ignored unless GenerateTangents and OverrideTangentCalculator are both set to true.

Syntax

// Setter
void SetTangentCalculatorInvertV( bool value ) const;

// Getter
bool GetTangentCalculatorInvertV() const;

SetTangentCalculatorInvertV parameters

Type	Name	Min	Max	Description
bool	value			The desired value for TangentCalculatorInvertV.

GetTangentCalculatorInvertV return value

Type: bool

Default: false

Syntax

// Setter
void SetTangentCalculatorInvertV(bool value);

// Getter
bool GetTangentCalculatorInvertV();

SetTangentCalculatorInvertV parameters

Type	Name	Min	Max	Description
bool	value			The desired value for TangentCalculatorInvertV.

GetTangentCalculatorInvertV return value

Type: bool

Default: false

Syntax

# Setter
None SetTangentCalculatorInvertV(value: bool)

# Getter
bool GetTangentCalculatorInvertV()

SetTangentCalculatorInvertV parameters

Name	Type	Min	Max	Description
value	bool			The desired value for TangentCalculatorInvertV.

GetTangentCalculatorInvertV return value

Type: bool

Default: false

TangentCalculatorType

The tangent calculator type to use when generating tangents for the mapping image data. Note that this setting is ignored unless GenerateTangents and OverrideTangentCalculator are both set to true.

Syntax

// Setter
void SetTangentCalculatorType( Simplygon::ETangentSpaceMethod value ) const;

// Getter
Simplygon::ETangentSpaceMethod GetTangentCalculatorType() const;

SetTangentCalculatorType parameters

Type	Name	Min	Max	Description
ETangentSpaceMethod	value			The desired value for TangentCalculatorType.

GetTangentCalculatorType return value

Type: ETangentSpaceMethod

Default: MikkTSpace

Key	Value	Comment
OrthonormalRightHanded	0	Standard method, creates an orthonormal tangent space (right-handed)
Autodesk3dsMax	1	3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer
OrthonormalLeftHanded	2	Creates an orthonormal tangent space (left-handed, D3D compatible)
MikkTSpace	3	Creates a tangent space using the MikkTSpace tangent space generation algorithm.
ImplicitOrthonormalRightHandedCompatible	4	Creates a tangent space which is compatible with tangents that are implicitly calculated in the Fragment Shader. Used for example in Unreal Engine when using Nanite.

Syntax

// Setter
void SetTangentCalculatorType(ETangentSpaceMethod value);

// Getter
ETangentSpaceMethod GetTangentCalculatorType();

SetTangentCalculatorType parameters

Type	Name	Min	Max	Description
ETangentSpaceMethod	value			The desired value for TangentCalculatorType.

GetTangentCalculatorType return value

Type: ETangentSpaceMethod

Default: MikkTSpace

Key	Value	Comment
OrthonormalRightHanded	0	Standard method, creates an orthonormal tangent space (right-handed)
Autodesk3dsMax	1	3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer
OrthonormalLeftHanded	2	Creates an orthonormal tangent space (left-handed, D3D compatible)
MikkTSpace	3	Creates a tangent space using the MikkTSpace tangent space generation algorithm.
ImplicitOrthonormalRightHandedCompatible	4	Creates a tangent space which is compatible with tangents that are implicitly calculated in the Fragment Shader. Used for example in Unreal Engine when using Nanite.

Syntax

# Setter
None SetTangentCalculatorType(value: ETangentSpaceMethod_*)

# Getter
ETangentSpaceMethod_* GetTangentCalculatorType()

SetTangentCalculatorType parameters

Name	Type	Min	Max	Description
value	ETangentSpaceMethod			The desired value for TangentCalculatorType.

GetTangentCalculatorType return value

Type: ETangentSpaceMethod

Default: MikkTSpace

Key	Value	Comment
ETangentSpaceMethod_OrthonormalRightHanded	0	Standard method, creates an orthonormal tangent space (right-handed)
ETangentSpaceMethod_Autodesk3dsMax	1	3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer
ETangentSpaceMethod_OrthonormalLeftHanded	2	Creates an orthonormal tangent space (left-handed, D3D compatible)
ETangentSpaceMethod_MikkTSpace	3	Creates a tangent space using the MikkTSpace tangent space generation algorithm.
ETangentSpaceMethod_ImplicitOrthonormalRightHandedCompatible	4	Creates a tangent space which is compatible with tangents that are implicitly calculated in the Fragment Shader. Used for example in Unreal Engine when using Nanite.

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

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

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

# 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 destination texture coordinate level used for mapping image and output texture generation. This selects the field on the processed geometry, not the original UV field used to sample input material textures; configure that separately in the source material's ShadingTextureNode. Generated tangent and bitangent fields use this same level. If TexCoordName is non-empty, TexCoordLevel is ignored, including for tangent generation. In that case, resolve the actual output level with GeometryData::GetNamedTexCoordsIndex(TexCoordName) rather than assuming it equals this setting.

Syntax

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

Syntax

// Setter
void SetTexCoordLevel(int value);

// Getter
int GetTexCoordLevel();

SetTexCoordLevel parameters

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

GetTexCoordLevel return value

Type: int

Default: 0

Syntax

# Setter
None SetTexCoordLevel(value: int)

# Getter
int GetTexCoordLevel()

SetTexCoordLevel parameters

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

GetTexCoordLevel return value

Type: int

Default: 0

TexCoordName

The alternative name of the destination texture coordinate field used for mapping image and output texture generation. This selects the field on the processed geometry, not the original UV field used to sample input material textures; configure that separately in the source material's ShadingTextureNode. A non-empty name takes precedence over TexCoordLevel. If new UVs are created, they replace the coordinates in the field with this alternative name. If no such field exists, it is created at the first available texture coordinate level, not necessarily at TexCoordLevel. If TexCoordName is null or empty, TexCoordLevel is used instead. Generated tangent and bitangent fields use the actual level of this texture coordinate field, but their alternative names are null. To retrieve them by the texture coordinate name, call GeometryData::GetNamedTexCoordsIndex(name), check that the result is not -1, then call GetTangents(level) and GetBitangents(level). GetNamedTangents(name) and GetNamedBitangents(name) do not resolve a texture coordinate alternative name.

Syntax

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

Syntax

// Setter
void SetTexCoordName(string value);

// Getter
string GetTexCoordName();

SetTexCoordName parameters

Type	Name	Min	Max	Description
string	value			The TexCoord level name.

GetTexCoordName return value

Type: string

Default: null

Syntax

# Setter
None SetTexCoordName(value: str)

# Getter
str GetTexCoordName()

SetTexCoordName parameters

Name	Type	Min	Max	Description
value	str			The TexCoord level name.

GetTexCoordName return value

Type: str

Default: None

UseAutomaticTextureSize

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

Syntax

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

Syntax

// Setter
void SetUseAutomaticTextureSize(bool value);

// Getter
bool GetUseAutomaticTextureSize();

SetUseAutomaticTextureSize parameters

Type	Name	Min	Max	Description
bool	value			The desired flag.

GetUseAutomaticTextureSize return value

Type: bool

Default: false

Syntax

# Setter
None SetUseAutomaticTextureSize(value: bool)

# Getter
bool GetUseAutomaticTextureSize()

SetUseAutomaticTextureSize parameters

Name	Type	Min	Max	Description
value	bool			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

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

Syntax

// Setter
void SetUseFullRetexturing(bool value);

// Getter
bool GetUseFullRetexturing();

SetUseFullRetexturing parameters

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

GetUseFullRetexturing return value

Type: bool

Default: false

Syntax

# Setter
None SetUseFullRetexturing(value: bool)

# Getter
bool GetUseFullRetexturing()

SetUseFullRetexturing parameters

Name	Type	Min	Max	Description
value	bool			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

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

Syntax

int AddObserver(spObserver observer);

Parameters

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

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

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

Return value

Type: int

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

Syntax

bool GetBoolParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: bool

GetChartAggregatorSettings

The settings for the chart aggregator.

Syntax

spChartAggregatorSettings GetChartAggregatorSettings() const;

Parameters

GetChartAggregatorSettings takes no parameters.

Return value

Type: ChartAggregatorSettings

Syntax

spChartAggregatorSettings GetChartAggregatorSettings();

Parameters

GetChartAggregatorSettings takes no parameters.

Return value

Type: ChartAggregatorSettings

Syntax

spChartAggregatorSettings GetChartAggregatorSettings()

Parameters

GetChartAggregatorSettings takes no parameters.

Return value

Type: ChartAggregatorSettings

GetClass

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

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

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

Syntax

double GetDoubleParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: double

Syntax

float GetDoubleParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: float

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

Syntax

string GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: string

Syntax

str GetErrorString()

Parameters

GetErrorString takes no parameters.

Return value

Type: str

GetInputMaterialSettings

Get the input material settings for the given index.

Syntax

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

Syntax

spMappingImageInputMaterialSettings GetInputMaterialSettings(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Input index

Return value

Type: MappingImageInputMaterialSettings

Syntax

spMappingImageInputMaterialSettings GetInputMaterialSettings(index: int)

Parameters

Name	Type	Min	Max	Description
index	int	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Input index

Return value

Type: MappingImageInputMaterialSettings

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

Syntax

int GetIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

GetOutputMaterialSettings

Get the output material settings for the given index.

Syntax

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

Syntax

spMappingImageOutputMaterialSettings GetOutputMaterialSettings(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Output index

Return value

Type: MappingImageOutputMaterialSettings

Syntax

spMappingImageOutputMaterialSettings GetOutputMaterialSettings(index: int)

Parameters

Name	Type	Min	Max	Description
index	int	0	SG_MAXIMUM_MAPPING_IMAGE_INPUT_MATERIAL_COUNT	Output index

Return value

Type: MappingImageOutputMaterialSettings

GetParameterizerSettings

The settings for the parameterizer.

Syntax

spParameterizerSettings GetParameterizerSettings() const;

Parameters

GetParameterizerSettings takes no parameters.

Return value

Type: ParameterizerSettings

Syntax

spParameterizerSettings GetParameterizerSettings();

Parameters

GetParameterizerSettings takes no parameters.

Return value

Type: ParameterizerSettings

Syntax

spParameterizerSettings GetParameterizerSettings()

Parameters

GetParameterizerSettings takes no parameters.

Return value

Type: ParameterizerSettings

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

Syntax

string GetStringParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: string

Syntax

str GetStringParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: str

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

Syntax

uint GetUIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: uint

Syntax

int GetUIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

IsA

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

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

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

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

bool IsSameObjectAs(spObject object);

Parameters

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

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	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

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

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

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

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.

Syntax

void RemoveObserver(int observerId);

Parameters

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

Syntax

None RemoveObserver(observerId: int)

Parameters

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

Syntax

bool SetBoolParameter(string name, bool value);

Parameters

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

Return value

Type: bool

Syntax

bool SetBoolParameter(name: str, value: bool)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	bool			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

Syntax

bool SetDoubleParameter(string name, double value);

Parameters

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

Return value

Type: bool

Syntax

bool SetDoubleParameter(name: str, value: float)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	float			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

Syntax

bool SetIntParameter(string name, int value);

Parameters

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

Return value

Type: bool

Syntax

bool SetIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			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

Syntax

bool SetStringParameter(string name, string value);

Parameters

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

Return value

Type: bool

Syntax

bool SetStringParameter(name: str, value: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	str			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

Syntax

bool SetUIntParameter(string name, uint value);

Parameters

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

Return value

Type: bool

Syntax

bool SetUIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			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.

Syntax

void SetValidateParameterNames(bool validate);

Parameters

Type	Name	Min	Max	Description
bool	validate			Flag indicating if validation is performed or not.

Syntax

None SetValidateParameterNames(validate: bool)

Parameters

Name	Type	Min	Max	Description
validate	bool			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

Syntax

string ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: string

Syntax

str ToJSON()

Parameters

ToJSON takes no parameters.

Return value

Type: str

ValidateSettings

Validates the current settings values.

Syntax

bool ValidateSettings() const;

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

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

Syntax

static bool IsClassA(string type);

Parameters

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

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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

static spMappingImageSettings SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: MappingImageSettings

Syntax

static spMappingImageSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: MappingImageSettings

Syntax

@staticmethod
spMappingImageSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: MappingImageSettings