class AmbientOcclusionCaster
AmbientOcclusionCaster generates an ambient occlusion map based on the original geometry, and casts it.
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. |
| GetAmbientOcclusionCasterSettings | The ambient occlusion caster settings object. |
| GetClass | Get the name of the AmbientOcclusionCaster class. |
| GetMaterialCasterSettings | The settings object. |
| GetPercentDone | Returns the current progress of the processing as a value between 0 and 100. |
| IsA | Returns true if AmbientOcclusionCaster is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the AmbientOcclusionCaster object is invalid. |
| RunProcessing | Runs the processing the object is designed for. |
| SetAdditionalSourceScene | An additional scene that will be used to compute the ambient occlusion on the main scene. |
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 spAmbientOcclusionCaster, and if this is the case, returns the object cast into spAmbientOcclusionCaster. |
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 |
|---|
rid | value | | | The value to which DestMaterialId will be set. |
GetDestMaterialId return value
Type: rid
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
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
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.
GetAmbientOcclusionCasterSettings
The ambient occlusion caster settings object.
GetClass
Get the name of the AmbientOcclusionCaster class.
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.
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 AmbientOcclusionCaster is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if AmbientOcclusionCaster 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 AmbientOcclusionCaster 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 AmbientOcclusionCaster is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AmbientOcclusionCaster object is invalid.
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
RunProcessing
Runs the processing the object is designed for.
Syntax
Parameters
RunProcessing takes no parameters.
Syntax
Parameters
RunProcessing takes no parameters.
Syntax
Parameters
RunProcessing takes no parameters.
SetAdditionalSourceScene
An additional scene that will be used to compute the ambient occlusion on the main scene.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The additional scene. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Scene | value | | | The additional scene. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| value | Scene | | | The additional scene. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
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 spAmbientOcclusionCaster, and if this is the case, returns the object cast into spAmbientOcclusionCaster.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: AmbientOcclusionCaster
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: AmbientOcclusionCaster
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: AmbientOcclusionCaster
