# 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. (Inherited from MaterialCasterSettings)
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. (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)
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. (Inherited from MaterialCasterSettings)
Name The name of the DisplacementCasterSettings object. (Inherited from Object)
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. 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 DisplacementCasterSettings 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 DisplacementCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the DisplacementCasterSettings object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the DisplacementCasterSettings object is valid. (Inherited from Object)
NonNull Returns true if the DisplacementCasterSettings object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the DisplacementCasterSettings 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 spDisplacementCasterSettings, and if this is the case, returns the object cast into spDisplacementCasterSettings. (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.

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

                # Name

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

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

                                                  # IsNull

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

                                                    # IsSameObjectAs

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

                                                      # NonNull

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

                                                        # PrintInfo

                                                        Prints the content/info of the DisplacementCasterSettings 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 spDisplacementCasterSettings, and if this is the case, returns the object cast into spDisplacementCasterSettings. (Inherited from Object)