# class OpacityCaster

OpacityCaster is the interface used to cast opacity values. To be used when opacity is needed as a separate texture. IMPORTANT: Make sure to set OpacityChannel to the channel you want to cast, since this caster bakes opacity rather than the channel set in the MaterialChannel setting like most other casters.

# 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 OpacityCaster 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)
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 OpacityCaster class. (Inherited from Object)
GetMaterialCasterSettings The settings object. (Inherited from MaterialCaster)
GetOpacityCasterSettings The opacity caster settings object.
GetPercentDone Returns the current progress of the processing as a value between 0 and 100. (Inherited from ProcessingObject)
IsA Returns true if OpacityCaster is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the OpacityCaster object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the OpacityCaster 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 OpacityCaster object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the OpacityCaster 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. (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 spOpacityCaster, and if this is the case, returns the object cast into spOpacityCaster. (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 OpacityCaster 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.

            # 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 OpacityCaster class. (Inherited from Object)

                      # GetMaterialCasterSettings

                      The settings object.

                        # GetOpacityCasterSettings

                        The opacity caster settings object.

                          # GetPercentDone

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

                            # IsA

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

                              # IsNull

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

                                # IsSameObjectAs

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

                                  # NewCopy

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

                                    # NonNull

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

                                      # PrintInfo

                                      Prints the content/info of the OpacityCaster 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.

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