`class` GeometryDataCasterSettings

GeometryDataCasterSettings is the interface used to manage settings for GeometryDataCaster

Properties

Property	Description
Dilation	The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels. (Inherited from MaterialCasterSettings)
DitherType	The type of dithering to use when creating the output object. (Inherited from MaterialCasterSettings)
FillMode	The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation. (Inherited from MaterialCasterSettings)
GeometryDataFieldIndex	The GeometryDataFieldIndex setting, which specifies what field index to cast in the GeometryDataCaster, for fields where it is applicable (TexCoords, Tangents, Bitangents and Colors). The setting is ignored for other field types.
GeometryDataFieldType	The GeometryDataFieldType setting, which specifies what field type to cast in the GeometryDataCaster.
MappingInf	The inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingInfA	Property the inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingInfB	The inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingInfG	The inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingInfR	The inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingLayerIndex	The MappingLayerIndex setting, which specifies the layer of the mapping image to use for mapping the geometry data. This is useful eg if you have decals which are on layer 0, and the real geometry on layer 1
MappingSup	The Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingSupA	Property the Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingSupB	The Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingSupG	The Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MappingSupR	The Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.
MaterialChannel	The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast. (Inherited from MaterialCasterSettings)
Name	The name of the GeometryDataCasterSettings object. (Inherited from Object)
OpacityChannel	The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property. (Inherited from MaterialCasterSettings)
OpacityChannelComponent	The component in the opacity channel to use as opacity value. (Inherited from MaterialCasterSettings)
OutputDDSCompressionType	DDS compression if output format is DDS. (Inherited from MaterialCasterSettings)
OutputImageFileFormat	File format for output texture. (Inherited from MaterialCasterSettings)
OutputPixelFormat	The output pixel format (Inherited from MaterialCasterSettings)
UseMultisampling	Enable or disable multisampling. (Inherited from MaterialCasterSettings)

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameter	Get a named parameter boolean value. (Inherited from SettingsObject)
GetClass	Get the name of the GeometryDataCasterSettings 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 GeometryDataCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the GeometryDataCasterSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the GeometryDataCasterSettings object is valid. (Inherited from Object)
NonNull	Returns true if the GeometryDataCasterSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the GeometryDataCasterSettings 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 spGeometryDataCasterSettings, and if this is the case, returns the object cast into spGeometryDataCasterSettings. (Inherited from Object)

Properties details

Dilation

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

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

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

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

DitherType

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

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

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

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

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

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

Key	Value	Comment
EDitherPatterns_NoDither	0	Use no dithering
EDitherPatterns_FloydSteinberg	1	Use Floyd-Steinberg dithering
EDitherPatterns_JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
EDitherPatterns_Sierra	3	Use Sierra-3 (three row) dithering

FillMode

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

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

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

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

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

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

Key	Value	Comment
EAtlasFillMode_Interpolate	0	linearly interpolate the closest samples
EAtlasFillMode_NearestNeighbor	1	use the closest available pixel value without interpolation
EAtlasFillMode_NoFill	2	Do not fill remaining pixels

GeometryDataFieldIndex

The GeometryDataFieldIndex setting, which specifies what field index to cast in the GeometryDataCaster, for fields where it is applicable (TexCoords, Tangents, Bitangents and Colors). The setting is ignored for other field types.

Type	Name	Min	Max	Description
`unsigned int`	fieldIndex	0	UINT_MAX	Value the field index for the selected field type, if applicable. Allowed max value depend on the field type selected.

Type	Name	Min	Max	Description
`uint`	fieldIndex	0	UINT_MAX	Value the field index for the selected field type, if applicable. Allowed max value depend on the field type selected.

Name	Type	Min	Max	Description
fieldIndex	`int`	0	UINT_MAX	Value the field index for the selected field type, if applicable. Allowed max value depend on the field type selected.

GeometryDataFieldType

The GeometryDataFieldType setting, which specifies what field type to cast in the GeometryDataCaster.

Type	Name	Min	Max	Description
EGeometryDataFieldType	fieldType			The field type to set. Specified in the GeometryDataFieldTypes enum.

Key	Value	Comment
Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
UserVertexField	9	User-defined Per-vertex geometry data field.
UserCornerField	10	User-defined Per-corner geometry data field.
UserTriangleField	11	User-defined Per-triangle geometry data field.
CustomField	12	Custom-size user-defined geometry data field.

Type	Name	Min	Max	Description
EGeometryDataFieldType	fieldType			The field type to set. Specified in the GeometryDataFieldTypes enum.

Key	Value	Comment
Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
UserVertexField	9	User-defined Per-vertex geometry data field.
UserCornerField	10	User-defined Per-corner geometry data field.
UserTriangleField	11	User-defined Per-triangle geometry data field.
CustomField	12	Custom-size user-defined geometry data field.

Name	Type	Min	Max	Description
fieldType	EGeometryDataFieldType			The field type to set. Specified in the GeometryDataFieldTypes enum.

Key	Value	Comment
EGeometryDataFieldType_Coords	0	Per-vertex coordinate data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_TexCoords	1	Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2)
EGeometryDataFieldType_Normals	2	Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Tangents	3	Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Bitangents	4	Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3)
EGeometryDataFieldType_Colors	5	Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4)
EGeometryDataFieldType_TriangleIds	6	Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_MaterialIds	7	Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_VertexIds	8	Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32)
EGeometryDataFieldType_UserVertexField	9	User-defined Per-vertex geometry data field.
EGeometryDataFieldType_UserCornerField	10	User-defined Per-corner geometry data field.
EGeometryDataFieldType_UserTriangleField	11	User-defined Per-triangle geometry data field.
EGeometryDataFieldType_CustomField	12	Custom-size user-defined geometry data field.

MappingInf

The inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.

Type	Name	Min	Max	Description
`RealData`	vec	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The minimum value for each channel (RGBA, 4 values).

Type	Name	Min	Max	Description
`float[]`	vec	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The minimum value for each channel (RGBA, 4 values).

Name	Type	Min	Max	Description
vec	`float`	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The minimum value for each channel (RGBA, 4 values).

MappingInfA

Property the inferior/minimum value of field values to map onto the image data range (0->1). The minimum value will be represented by 0 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.

Type	Name	Min	Max	Description
`real`	value	-REAL_MAX	REAL_MAX	The minimum value for the alpha channel.

Type	Name	Min	Max	Description
`float`	value	-REAL_MAX	REAL_MAX	The minimum value for the alpha channel.

Name	Type	Min	Max	Description
value	`float`	-REAL_MAX	REAL_MAX	The minimum value for the alpha channel.

MappingInfB

Type	Name	Min	Max	Description
`real`	value	-REAL_MAX	REAL_MAX	The minimum value for the blue channel.

Type	Name	Min	Max	Description
`float`	value	-REAL_MAX	REAL_MAX	The minimum value for the blue channel.

Name	Type	Min	Max	Description
value	`float`	-REAL_MAX	REAL_MAX	The minimum value for the blue channel.

MappingInfG

Type	Name	Min	Max	Description
`real`	value	-REAL_MAX	REAL_MAX	The minimum value for the green channel.

Type	Name	Min	Max	Description
`float`	value	-REAL_MAX	REAL_MAX	The minimum value for the green channel.

Name	Type	Min	Max	Description
value	`float`	-REAL_MAX	REAL_MAX	The minimum value for the green channel.

MappingInfR

Type	Name	Min	Max	Description
`real`	value	-REAL_MAX	REAL_MAX	The minimum value for the red channel.

Type	Name	Min	Max	Description
`float`	value	-REAL_MAX	REAL_MAX	The minimum value for the red channel.

Name	Type	Min	Max	Description
value	`float`	-REAL_MAX	REAL_MAX	The minimum value for the red channel.

MappingLayerIndex

The MappingLayerIndex setting, which specifies the layer of the mapping image to use for mapping the geometry data. This is useful eg if you have decals which are on layer 0, and the real geometry on layer 1

Type	Name	Min	Max	Description
`unsigned int`	layerIndex	0	UINT_MAX	The layer index to use.

Type	Name	Min	Max	Description
`uint`	layerIndex	0	UINT_MAX	The layer index to use.

Name	Type	Min	Max	Description
layerIndex	`int`	0	UINT_MAX	The layer index to use.

MappingSup

The Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.

Type	Name	Min	Max	Description
`RealData`	vec	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The maximum value for each channel (RGBA, 4 values).

Type	Name	Min	Max	Description
`float[]`	vec	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The maximum value for each channel (RGBA, 4 values).

Name	Type	Min	Max	Description
vec	`float`	-REAL_MAX,-REAL_MAX,-REAL_MAX,-REAL_MAX	REAL_MAX,REAL_MAX,REAL_MAX,REAL_MAX	The maximum value for each channel (RGBA, 4 values).

MappingSupA

Property the Superior/maximum value of field values to map onto the image data range (0->1). The maximum value will be represented by 1 in the image. Note that the mapping is only used for real value fields, not id-based fields, which cannot be scaled accurately.

Type	Name	Min	Max	Description
`real`	value	-REAL_MAX	REAL_MAX	The maximum value for the alpha channel.

Type	Name	Min	Max	Description
`float`	value	-REAL_MAX	REAL_MAX	The maximum value for the alpha channel.

MappingSupB

MappingSupG

MappingSupR

MaterialChannel

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

Name

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

OpacityChannel

The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property.

OpacityChannelComponent

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

OutputDDSCompressionType

DDS compression if output format is DDS.

OutputImageFileFormat

File format for output texture.

OutputPixelFormat

The output pixel format

UseMultisampling

Enable or disable multisampling.

Methods details

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.

GetClass

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

GetDoubleParameter

Get a named parameter floating point value.

GetErrorString

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

GetIntParameter

Get a named parameter integer value.

GetStringParameter

Get a named parameter string value.

GetUIntParameter

Get a named parameter unsigned integer value.

IsA

Returns true if GeometryDataCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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

RemoveObserver

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

SetBoolParameter

Set a named parameter boolean value.

SetDoubleParameter

Set a named parameter floating point value.

SetIntParameter

Set a named parameter integer value.

SetStringParameter

Set a named parameter string value.

SetUIntParameter

Set a named parameter unsigned integer value.

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.

ToJSON

Get settings as JSON for debugging purposes.

ValidateSettings

Validates the current settings values.

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)

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spGeometryDataCasterSettings, and if this is the case, returns the object cast into spGeometryDataCasterSettings. (Inherited from Object)

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

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

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

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

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

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class GeometryDataCasterSettings ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Dilation ​

DitherType ​

FillMode ​

GeometryDataFieldIndex ​

GeometryDataFieldType ​

MappingInf ​

MappingInfA ​

MappingInfB ​

MappingInfG ​

MappingInfR ​