class AmbientOcclusionCasterSettings
AmbientOcclusionCasterSettings manages settings for an ambient occlusion caster.
Properties
| Property | Description |
|---|
| Dilation | The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels. (Inherited from MaterialCasterSettings) |
| DitherType | The type of dithering to use when creating the output object. (Inherited from MaterialCasterSettings) |
| FillMode | The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation. (Inherited from MaterialCasterSettings) |
| MaterialChannel | The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast. (Inherited from MaterialCasterSettings) |
| Name | The name of the AmbientOcclusionCasterSettings object. (Inherited from Object) |
| OcclusionFalloff | How far away a surface has to be from another surface to generate no occlusion. Only applicable if SimpleOcclusionMode is off. |
| OcclusionMultiplier | This is just a basic intensity scaler. Higher is "darker". |
| OpacityChannel | The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property. (Inherited from MaterialCasterSettings) |
| OpacityChannelComponent | The component in the opacity channel to use as opacity value. (Inherited from MaterialCasterSettings) |
| OutputDDSCompressionType | DDS compression if output format is DDS. (Inherited from MaterialCasterSettings) |
| OutputImageFileFormat | File format for output texture. (Inherited from MaterialCasterSettings) |
| OutputPixelFormat | The output pixel format (Inherited from MaterialCasterSettings) |
| RaysPerPixel | This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion. |
| UseMultisampling | Enable or disable multisampling. (Inherited from MaterialCasterSettings) |
| UseSimpleOcclusionMode | If set, occlusion will not scale with distance, each ray will only be either fully occluded or not at all. Speeds up processing time. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the AmbientOcclusionCasterSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if AmbientOcclusionCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the AmbientOcclusionCasterSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the AmbientOcclusionCasterSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the AmbientOcclusionCasterSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the AmbientOcclusionCasterSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
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 spAmbientOcclusionCasterSettings, and if this is the case, returns the object cast into spAmbientOcclusionCasterSettings. (Inherited from Object) |
Properties details
Dilation
The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.
Syntax
SetDilation parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | 1000 | The value to which Dilation will be set. |
GetDilation return value
Type: unsigned int
Default: 10
Syntax
SetDilation parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | 1000 | The value to which Dilation will be set. |
GetDilation return value
Type: uint
Default: 10
Syntax
SetDilation parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | 1000 | The value to which Dilation will be set. |
GetDilation return value
Type: int
Default: 10
DitherType
The type of dithering to use when creating the output object.
Syntax
SetDitherType parameters
| Type | Name | Min | Max | Description |
|---|
| EDitherPatterns | value | | | The desired value of the DitherType to use. |
GetDitherType return value
Type: EDitherPatterns
Default: FloydSteinberg
| Key | Value | Comment |
|---|
| NoDither | 0 | Use no dithering |
| FloydSteinberg | 1 | Use Floyd-Steinberg dithering |
| JarvisJudiceNinke | 2 | Use Jarvis, Judice, and Ninke dithering |
| Sierra | 3 | Use Sierra-3 (three row) dithering |
Syntax
SetDitherType parameters
| Type | Name | Min | Max | Description |
|---|
| EDitherPatterns | value | | | The desired value of the DitherType to use. |
GetDitherType return value
Type: EDitherPatterns
Default: FloydSteinberg
| Key | Value | Comment |
|---|
| NoDither | 0 | Use no dithering |
| FloydSteinberg | 1 | Use Floyd-Steinberg dithering |
| JarvisJudiceNinke | 2 | Use Jarvis, Judice, and Ninke dithering |
| Sierra | 3 | Use Sierra-3 (three row) dithering |
Syntax
SetDitherType parameters
| Name | Type | Min | Max | Description |
|---|
| value | EDitherPatterns | | | The desired value of the DitherType to use. |
GetDitherType return value
Type: EDitherPatterns
Default: FloydSteinberg
| Key | Value | Comment |
|---|
| EDitherPatterns_NoDither | 0 | Use no dithering |
| EDitherPatterns_FloydSteinberg | 1 | Use Floyd-Steinberg dithering |
| EDitherPatterns_JarvisJudiceNinke | 2 | Use Jarvis, Judice, and Ninke dithering |
| EDitherPatterns_Sierra | 3 | Use Sierra-3 (three row) dithering |
FillMode
The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: None = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.
Syntax
SetFillMode parameters
| Type | Name | Min | Max | Description |
|---|
| EAtlasFillMode | value | | | The mode to which the fill mode will be set. |
GetFillMode return value
Type: EAtlasFillMode
Default: Interpolate
| Key | Value | Comment |
|---|
| Interpolate | 0 | linearly interpolate the closest samples |
| NearestNeighbor | 1 | use the closest available pixel value without interpolation |
| NoFill | 2 | Do not fill remaining pixels |
Syntax
SetFillMode parameters
| Type | Name | Min | Max | Description |
|---|
| EAtlasFillMode | value | | | The mode to which the fill mode will be set. |
GetFillMode return value
Type: EAtlasFillMode
Default: Interpolate
| Key | Value | Comment |
|---|
| Interpolate | 0 | linearly interpolate the closest samples |
| NearestNeighbor | 1 | use the closest available pixel value without interpolation |
| NoFill | 2 | Do not fill remaining pixels |
Syntax
SetFillMode parameters
| Name | Type | Min | Max | Description |
|---|
| value | EAtlasFillMode | | | The mode to which the fill mode will be set. |
GetFillMode return value
Type: EAtlasFillMode
Default: Interpolate
| Key | Value | Comment |
|---|
| EAtlasFillMode_Interpolate | 0 | linearly interpolate the closest samples |
| EAtlasFillMode_NearestNeighbor | 1 | use the closest available pixel value without interpolation |
| EAtlasFillMode_NoFill | 2 | Do not fill remaining pixels |
MaterialChannel
The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
Syntax
SetMaterialChannel parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The input material channel name. |
GetMaterialChannel return value
Type: spString
Default: nullptr
Syntax
SetMaterialChannel parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The input material channel name. |
GetMaterialChannel return value
Type: string
Default: null
Syntax
SetMaterialChannel parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The input material channel name. |
GetMaterialChannel return value
Type: str
Default: None
Name
The name of the AmbientOcclusionCasterSettings 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
OcclusionFalloff
How far away a surface has to be from another surface to generate no occlusion. Only applicable if SimpleOcclusionMode is off.
Syntax
SetOcclusionFalloff parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The far occlusion falloff. |
GetOcclusionFalloff return value
Type: real
Default: -1.0
Syntax
SetOcclusionFalloff parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The far occlusion falloff. |
GetOcclusionFalloff return value
Type: float
Default: -1.0
Syntax
SetOcclusionFalloff parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The far occlusion falloff. |
GetOcclusionFalloff return value
Type: float
Default: -1.0
OcclusionMultiplier
This is just a basic intensity scaler. Higher is "darker".
Syntax
SetOcclusionMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The occlusion multiplier. |
GetOcclusionMultiplier return value
Type: real
Default: -1.0
Syntax
SetOcclusionMultiplier parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The occlusion multiplier. |
GetOcclusionMultiplier return value
Type: float
Default: -1.0
Syntax
SetOcclusionMultiplier parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The occlusion multiplier. |
GetOcclusionMultiplier return value
Type: float
Default: -1.0
OpacityChannel
The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property.
Syntax
SetOpacityChannel parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired material channel. |
GetOpacityChannel return value
Type: spString
Default: Opacity
Syntax
SetOpacityChannel parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired material channel. |
GetOpacityChannel return value
Type: string
Default: Opacity
Syntax
SetOpacityChannel parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired material channel. |
GetOpacityChannel return value
Type: str
Default: Opacity
OpacityChannelComponent
The component in the opacity channel to use as opacity value.
Syntax
SetOpacityChannelComponent parameters
| Type | Name | Min | Max | Description |
|---|
| EColorComponent | value | | | The desired component in the opacity material channel to use as opacity value. |
GetOpacityChannelComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| Red | 0 | Red color component |
| Green | 1 | Green color component |
| Blue | 2 | Blue color component |
| Alpha | 3 | Alpha color component |
Syntax
SetOpacityChannelComponent parameters
| Type | Name | Min | Max | Description |
|---|
| EColorComponent | value | | | The desired component in the opacity material channel to use as opacity value. |
GetOpacityChannelComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| Red | 0 | Red color component |
| Green | 1 | Green color component |
| Blue | 2 | Blue color component |
| Alpha | 3 | Alpha color component |
Syntax
SetOpacityChannelComponent parameters
| Name | Type | Min | Max | Description |
|---|
| value | EColorComponent | | | The desired component in the opacity material channel to use as opacity value. |
GetOpacityChannelComponent return value
Type: EColorComponent
Default: Red
| Key | Value | Comment |
|---|
| EColorComponent_Red | 0 | Red color component |
| EColorComponent_Green | 1 | Green color component |
| EColorComponent_Blue | 2 | Blue color component |
| EColorComponent_Alpha | 3 | Alpha color component |
OutputDDSCompressionType
DDS compression if output format is DDS.
Syntax
SetOutputDDSCompressionType parameters
GetOutputDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| NoCompression | -1 | |
| BC1 | 0 | |
| BC2 | 1 | |
| BC3 | 2 | |
| BC4 | 3 | |
| BC5 | 4 | |
Syntax
SetOutputDDSCompressionType parameters
GetOutputDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| NoCompression | -1 | |
| BC1 | 0 | |
| BC2 | 1 | |
| BC3 | 2 | |
| BC4 | 3 | |
| BC5 | 4 | |
Syntax
SetOutputDDSCompressionType parameters
GetOutputDDSCompressionType return value
Type: EDDSCompressionType
Default: NoCompression
| Key | Value | Comment |
|---|
| EDDSCompressionType_NoCompression | -1 | |
| EDDSCompressionType_BC1 | 0 | |
| EDDSCompressionType_BC2 | 1 | |
| EDDSCompressionType_BC3 | 2 | |
| EDDSCompressionType_BC4 | 3 | |
| EDDSCompressionType_BC5 | 4 | |
File format for output texture.
Syntax
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| BMP | 0 | |
| DDS | 1 | |
| JPEG | 2 | |
| PNG | 3 | |
| TGA | 4 | |
| TIFF | 5 | |
| EXR | 8 | |
Syntax
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| BMP | 0 | |
| DDS | 1 | |
| JPEG | 2 | |
| PNG | 3 | |
| TGA | 4 | |
| TIFF | 5 | |
| EXR | 8 | |
Syntax
Type: EImageOutputFormat
Default: PNG
| Key | Value | Comment |
|---|
| EImageOutputFormat_BMP | 0 | |
| EImageOutputFormat_DDS | 1 | |
| EImageOutputFormat_JPEG | 2 | |
| EImageOutputFormat_PNG | 3 | |
| EImageOutputFormat_TGA | 4 | |
| EImageOutputFormat_TIFF | 5 | |
| EImageOutputFormat_EXR | 8 | |
The output pixel format
Syntax
| Type | Name | Min | Max | Description |
|---|
| EPixelFormat | value | | | The desired value to which OutputChannels will be set. |
Type: EPixelFormat
Default: R8G8B8A8
| Key | Value | Comment |
|---|
| R8G8B8A8 | 0 | RGBA color channels with 8 bit depth per color channel |
| R8G8B8 | 1 | RGB color channels with 8 bit depth per color channel |
| R8 | 2 | R color channel with 8 bit depth per color channel |
| R16G16B16A16 | 3 | RGBA color channels with 16 bit depth per color channel |
| R16G16B16 | 4 | RGB color channels with 16 bit depth per color channel |
| R16 | 5 | R color channel with 16 bit depth per color channel |
| R32G32B32A32F | 6 | RGBA color channels with 32 bit depth floating point per color channel |
Syntax
| Type | Name | Min | Max | Description |
|---|
| EPixelFormat | value | | | The desired value to which OutputChannels will be set. |
Type: EPixelFormat
Default: R8G8B8A8
| Key | Value | Comment |
|---|
| R8G8B8A8 | 0 | RGBA color channels with 8 bit depth per color channel |
| R8G8B8 | 1 | RGB color channels with 8 bit depth per color channel |
| R8 | 2 | R color channel with 8 bit depth per color channel |
| R16G16B16A16 | 3 | RGBA color channels with 16 bit depth per color channel |
| R16G16B16 | 4 | RGB color channels with 16 bit depth per color channel |
| R16 | 5 | R color channel with 16 bit depth per color channel |
| R32G32B32A32F | 6 | RGBA color channels with 32 bit depth floating point per color channel |
Syntax
| Name | Type | Min | Max | Description |
|---|
| value | EPixelFormat | | | The desired value to which OutputChannels will be set. |
Type: EPixelFormat
Default: R8G8B8A8
| Key | Value | Comment |
|---|
| EPixelFormat_R8G8B8A8 | 0 | RGBA color channels with 8 bit depth per color channel |
| EPixelFormat_R8G8B8 | 1 | RGB color channels with 8 bit depth per color channel |
| EPixelFormat_R8 | 2 | R color channel with 8 bit depth per color channel |
| EPixelFormat_R16G16B16A16 | 3 | RGBA color channels with 16 bit depth per color channel |
| EPixelFormat_R16G16B16 | 4 | RGB color channels with 16 bit depth per color channel |
| EPixelFormat_R16 | 5 | R color channel with 16 bit depth per color channel |
| EPixelFormat_R32G32B32A32F | 6 | RGBA color channels with 32 bit depth floating point per color channel |
RaysPerPixel
This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion.
Syntax
SetRaysPerPixel parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | UINT_MAX | The desired number of rays. |
GetRaysPerPixel return value
Type: unsigned int
Default: 64
Syntax
SetRaysPerPixel parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | UINT_MAX | The desired number of rays. |
GetRaysPerPixel return value
Type: uint
Default: 64
Syntax
SetRaysPerPixel parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | UINT_MAX | The desired number of rays. |
GetRaysPerPixel return value
Type: int
Default: 64
UseMultisampling
Enable or disable multisampling.
Syntax
SetUseMultisampling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of the flag. |
GetUseMultisampling return value
Type: bool
Default: true
Syntax
SetUseMultisampling parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of the flag. |
GetUseMultisampling return value
Type: bool
Default: true
Syntax
SetUseMultisampling parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired value of the flag. |
GetUseMultisampling return value
Type: bool
Default: true
UseSimpleOcclusionMode
If set, occlusion will not scale with distance, each ray will only be either fully occluded or not at all. Speeds up processing time.
Syntax
SetUseSimpleOcclusionMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to which UseSimpleOcclusionMode will be set. |
GetUseSimpleOcclusionMode return value
Type: bool
Default: false
Syntax
SetUseSimpleOcclusionMode parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to which UseSimpleOcclusionMode will be set. |
GetUseSimpleOcclusionMode return value
Type: bool
Default: false
Syntax
SetUseSimpleOcclusionMode parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The flag to which UseSimpleOcclusionMode will be set. |
GetUseSimpleOcclusionMode return value
Type: bool
Default: false
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
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the AmbientOcclusionCasterSettings 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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if AmbientOcclusionCasterSettings 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 AmbientOcclusionCasterSettings 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 AmbientOcclusionCasterSettings 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 AmbientOcclusionCasterSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AmbientOcclusionCasterSettings 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 AmbientOcclusionCasterSettings 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
NonNull
Returns true if the AmbientOcclusionCasterSettings 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 AmbientOcclusionCasterSettings 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. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
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
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
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 spAmbientOcclusionCasterSettings, and if this is the case, returns the object cast into spAmbientOcclusionCasterSettings. (Inherited from Object)
