Simplygon 9 Documentation

# 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.
MappingImage The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects.
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.
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

Method Description
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.
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.
IsNull Returns true if the DisplacementCaster object is invalid.
RunProcessing Runs the processing the object is designed for.
ToJSON Get settings as JSON for debugging purposes.

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

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

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

          # 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

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

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

                          # IsNull

                          Returns true if the DisplacementCaster object is invalid.

                            # RunProcessing

                            Runs the processing the object is designed for.

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

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

                                    ← GeometryDataCaster →