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.
Syntax
SetDestMaterialId parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | The value to which DestMaterialId will be set. |
GetDestMaterialId return value
Type: rid
Syntax
SetDestMaterialId parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The value to which DestMaterialId will be set. |
GetDestMaterialId return value
Type: int
Syntax
SetDestMaterialId parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The value to which DestMaterialId will be set. |
GetDestMaterialId return value
Type: int
MappingImage
The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects.
Syntax
SetMappingImage parameters
| Type | Name | Min | Max | Description |
|---|
| MappingImage | value | | | The mapping image to which MappingImage will be set. |
GetMappingImage return value
Type: MappingImage
Syntax
SetMappingImage parameters
| Type | Name | Min | Max | Description |
|---|
| MappingImage | value | | | The mapping image to which MappingImage will be set. |
GetMappingImage return value
Type: MappingImage
Syntax
SetMappingImage parameters
| Name | Type | Min | Max | Description |
|---|
| value | MappingImage | | | The mapping image to which MappingImage will be set. |
GetMappingImage return value
Type: MappingImage
Name
The name of the OpacityCaster object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
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.
Syntax
SetOutputFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The string to which OutputFilePath will be set. |
GetOutputFilePath return value
Type: spString
Syntax
SetOutputFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The string to which OutputFilePath will be set. |
GetOutputFilePath return value
Type: string
Syntax
SetOutputFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The string to which OutputFilePath will be set. |
GetOutputFilePath return value
Type: str
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.
Syntax
SetOutputImage parameters
| Type | Name | Min | Max | Description |
|---|
| ImageData | value | | | The image data to which OutputImage will be set. |
GetOutputImage return value
Type: ImageData
Syntax
SetOutputImage parameters
| Type | Name | Min | Max | Description |
|---|
| ImageData | value | | | The image data to which OutputImage will be set. |
GetOutputImage return value
Type: ImageData
Syntax
SetOutputImage parameters
| Name | Type | Min | Max | Description |
|---|
| value | ImageData | | | The image data to which OutputImage will be set. |
GetOutputImage return value
Type: ImageData
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.
Syntax
SetSourceMaterials parameters
| Type | Name | Min | Max | Description |
|---|
| MaterialTable | value | | | The material table to which SourceMaterials will be set. |
GetSourceMaterials return value
Type: MaterialTable
Syntax
SetSourceMaterials parameters
| Type | Name | Min | Max | Description |
|---|
| MaterialTable | value | | | The material table to which SourceMaterials will be set. |
GetSourceMaterials return value
Type: MaterialTable
Syntax
SetSourceMaterials parameters
| Name | Type | Min | Max | Description |
|---|
| value | MaterialTable | | | The material table to which SourceMaterials will be set. |
GetSourceMaterials return value
Type: MaterialTable
SourceTextures
The SourceTextures object. The SourceTextures object contains all textures of the the source geometry.
Syntax
SetSourceTextures parameters
| Type | Name | Min | Max | Description |
|---|
| TextureTable | value | | | The texture table to which SourceTextures will be set. |
GetSourceTextures return value
Type: TextureTable
Syntax
SetSourceTextures parameters
| Type | Name | Min | Max | Description |
|---|
| TextureTable | value | | | The texture table to which SourceTextures will be set. |
GetSourceTextures return value
Type: TextureTable
Syntax
SetSourceTextures parameters
| Name | Type | Min | Max | Description |
|---|
| value | TextureTable | | | The texture table to which SourceTextures will be set. |
GetSourceTextures return value
Type: TextureTable
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
Clear
Clear all internal states of the object. This will NOT clear the parameters set in the object.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the OpacityCaster class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
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.
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: real
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
Syntax
Parameters
GetPercentDone takes no parameters.
Return value
Type: float
IsA
Returns true if OpacityCaster is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if OpacityCaster is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if OpacityCaster is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if OpacityCaster is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the OpacityCaster object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the OpacityCaster object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NewCopy
Create a new clone of the material caster, copying all settings.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: MaterialCaster
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Return value
Type: MaterialCaster
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
Return value
Type: MaterialCaster
NonNull
Returns true if the OpacityCaster object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the OpacityCaster object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
RunProcessing
Runs the processing the object is designed for.
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| Finished | 0 | The process finished with no error |
| Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
Syntax
Parameters
RunProcessing takes no parameters.
Return value
Type: EProcessStatus
| Key | Value | Comment |
|---|
| EProcessStatus_Finished | 0 | The process finished with no error |
| EProcessStatus_Skipped | 1 | The process was skipped, in most cases because of a missing or invalid object, or that there was nothing to process. See the log for details. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: OpacityCaster
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to cast. |
Return value
Type: OpacityCaster
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: OpacityCaster
