Simplygon 9 Documentation

# class NormalCasterSettings

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

# 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.
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.
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.
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.
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
GetClass Get the name of the NormalCasterSettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
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.
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

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

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

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

                  # 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

                          # GetClass

                          Get the name of the NormalCasterSettings class.

                            # GetErrorString

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

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

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

                                        ← OcclusionMeshSettings →