# class NormalCasterSettings

NormalCasterSettings is the interface used to manage settings for a normal caster

# Properties

Property Description
CalculateBitangentPerFragment If set, the normal caster calculates the bitangent used for encoding per-fragment using the normal, tangent and bitangent sign instead of interpolating the actual bitangent vertex data. This needs to match the behaviour of the renderer to not produce rendering artifacts.
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.
DitherType The type of dithering to use when creating the output object.
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.
FlipBackfacingNormals If set, then normals will be flipped if they are back facing, i.e. pointing into the surface. This may introduce artifacts on geometries that have correctly facing normals, so only use for geometries with known back-facing normals.
FlipGreen If set, the green channel is assumed to point along the negative bitangent instead of the positive. This is roughly equivalent to switching between left- and righthanded, but some rounding may differ.
GenerateTangentSpaceNormals If set, then the generated normal map will be in tangent space. Please note that the geometry casted to must contain tangent space fields.
MaterialChannel The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
NormalizeInterpolatedTangentSpace If set, the normal caster normalizes the normal and tangent data used for encoding after interpolation. This needs to match the behaviour of the renderer to not produce rendering artifacts.
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.
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

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the NormalCasterSettings class.
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 NormalCasterSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the NormalCasterSettings object is invalid.
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

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spNormalCasterSettings, and if this is the case, returns the object cast into spNormalCasterSettings.

# Properties details

# CalculateBitangentPerFragment

If set, the normal caster calculates the bitangent used for encoding per-fragment using the normal, tangent and bitangent sign instead of interpolating the actual bitangent vertex data. This needs to match the behaviour of the renderer to not produce rendering artifacts.

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

      # DitherType

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

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

          # FlipBackfacingNormals

          If set, then normals will be flipped if they are back facing, i.e. pointing into the surface. This may introduce artifacts on geometries that have correctly facing normals, so only use for geometries with known back-facing normals.

            # FlipGreen

            If set, the green channel is assumed to point along the negative bitangent instead of the positive. This is roughly equivalent to switching between left- and righthanded, but some rounding may differ.

              # GenerateTangentSpaceNormals

              If set, then the generated normal map will be in tangent space. Please note that the geometry casted to must contain tangent space fields.

                # MaterialChannel

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

                  # NormalizeInterpolatedTangentSpace

                  If set, the normal caster normalizes the normal and tangent data used for encoding after interpolation. This needs to match the behaviour of the renderer to not produce rendering artifacts.

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

                      # 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

                                # GetBoolParameter

                                Get a named parameter boolean value.

                                  # GetClass

                                  Get the name of the NormalCasterSettings class.

                                    # 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 NormalCasterSettings is a or is a descendant of the class named as the type parameter.

                                                # IsNull

                                                Returns true if the NormalCasterSettings object is invalid.

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

                                                                    # SafeCast

                                                                    SafeCast makes sure the input object is of a class that can be cast into spNormalCasterSettings, and if this is the case, returns the object cast into spNormalCasterSettings.