# class DisplacementCaster

DisplacementCaster is used to store the delta-values between the original and processed geometries. The values are divided by a scaling value, and clamped into the -1 -> 1 range before being stored into an image.

# Properties

Property Description
DestMaterialId The DestMaterialId object. If set, only the parts of the destination map that. To disable, set to -1. (Inherited from MaterialCaster)
MappingImage The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects. (Inherited from MaterialCaster)
Name The name of the DisplacementCaster object. (Inherited from Object)
OutputFilePath The OutputFilePath file path, where the output image will be placed. Note that the extension will be appended the file path if it differs from the OutputImageFileFormat set in the caster settings object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored. (Inherited from MaterialCaster)
OutputImage The OutputImage object that will receive the image. The current contents of the image will be removed, and the image will be written to the Colors field of the ImageData object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored. (Inherited from MaterialCaster)
Scene The Scene object that will receive the data. Note that the scene object is only used when baking to geometry data, such as tessellated attributes or vertex data. (Inherited from MaterialCaster)
SourceMaterials The SourceMaterials object. The SourceMaterials object contains all materials of the the source geometry. The source geometry must have a "MaterialIds" field that indices the material table. (Inherited from MaterialCaster)
SourceTextures The SourceTextures object. The SourceTextures object contains all textures of the the source geometry. (Inherited from MaterialCaster)

# Methods

Method Description
AddObserver Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear Clear all internal states of the object. This will NOT clear the parameters set in the object. (Inherited from ProcessingObject)
GetClass Get the name of the DisplacementCaster class. (Inherited from Object)
GetDisplacementCasterSettings The displacement caster settings object.
GetMaterialCasterSettings The settings object. (Inherited from MaterialCaster)
GetPercentDone Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
IsA Returns true if DisplacementCaster is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the DisplacementCaster object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the DisplacementCaster object is valid. (Inherited from Object)
NewCopy Create a new clone of the material caster, copying all settings. (Inherited from MaterialCaster)
NonNull Returns true if the DisplacementCaster object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the DisplacementCaster object to the log. (Inherited from Object)
RemoveObserver Removes a previously added observer object. (Inherited from Object)
RunProcessing Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned. (Inherited from ProcessingObject)
ToJSON Get settings as JSON for debugging purposes. (Inherited from ProcessingObject)

# 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 spDisplacementCaster, and if this is the case, returns the object cast into spDisplacementCaster. (Inherited from Object)

# Properties details

# DestMaterialId

The DestMaterialId object. If set, only the parts of the destination map that. To disable, set to -1.

    # MappingImage

    The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects.

      # Name

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

        # OutputFilePath

        The OutputFilePath file path, where the output image will be placed. Note that the extension will be appended the file path if it differs from the OutputImageFileFormat set in the caster settings object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.

          # OutputImage

          The OutputImage object that will receive the image. The current contents of the image will be removed, and the image will be written to the Colors field of the ImageData object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.

            # Scene

            The Scene object that will receive the data. Note that the scene object is only used when baking to geometry data, such as tessellated attributes or vertex data.

              # SourceMaterials

              The SourceMaterials object. The SourceMaterials object contains all materials of the the source geometry. The source geometry must have a "MaterialIds" field that indices the material table.

                # SourceTextures

                The SourceTextures object. The SourceTextures object contains all textures of the the source geometry.

                  # Methods details

                  # AddObserver

                  Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

                    # Clear

                    Clear all internal states of the object. This will NOT clear the parameters set in the object.

                      # GetClass

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

                        # GetDisplacementCasterSettings

                        The displacement caster settings object.

                          # GetMaterialCasterSettings

                          The settings object.

                            # GetPercentDone

                            Returns the current progress of the processing as a value between 0 and 100.

                              # IsA

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

                                # IsNull

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

                                  # IsSameObjectAs

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

                                    # NewCopy

                                    Create a new clone of the material caster, copying all settings.

                                      # NonNull

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

                                        # PrintInfo

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

                                          # RemoveObserver

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

                                            # RunProcessing

                                            Runs the processing the object is designed for. If the process succeeds, the return value is NoError. If the process fails, and the error is recoverable, an error code is returned.

                                              # ToJSON

                                              Get settings as JSON for debugging purposes.

                                                # 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 spDisplacementCaster, and if this is the case, returns the object cast into spDisplacementCaster. (Inherited from Object)