# class DisplacementCasterSettings

DisplacementCasterSettings is used to store the settings for a displacement 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.
DistanceScaling All the delta values are divided by this value before storing them into an image.
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.
GenerateScalarDisplacement If set to true, the size of the displacement vector components in the direction of the interpolated normal are stored in the displacement map, instead of the displacement vectors.
GenerateTangentSpaceDisplacement If set, the displacement vectors are transformed into the destination object tangent space.
MaterialChannel The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
NormalMapTexCoordLevel The texture coordinate level to use for the tangent space displacement vectors.
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 DisplacementCasterSettings 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 DisplacementCasterSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the DisplacementCasterSettings 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.
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 spDisplacementCasterSettings, and if this is the case, returns the object cast into spDisplacementCasterSettings.

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

    # DistanceScaling

    All the delta values are divided by this value before storing them into an image.

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

          # GenerateScalarDisplacement

          If set to true, the size of the displacement vector components in the direction of the interpolated normal are stored in the displacement map, instead of the displacement vectors.

            # GenerateTangentSpaceDisplacement

            If set, the displacement vectors are transformed into the destination object tangent space.

              # MaterialChannel

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

                # NormalMapTexCoordLevel

                The texture coordinate level to use for the tangent space displacement vectors.

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

                                              # IsNull

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

                                                          # 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 spDisplacementCasterSettings, and if this is the case, returns the object cast into spDisplacementCasterSettings.