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.
DitherType	The type of dithering to use when creating the output object.
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.
MaterialChannel	The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.
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.
OpacityChannelComponent	The component in the opacity channel to use as opacity value.
OutputDDSCompressionType	DDS compression if output format is DDS.
OutputImageFileFormat	File format for output texture.
OutputPixelFormat	The output pixel format
RaysPerPixel	This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion.
UseMultisampling	Enable or disable multisampling.
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
GetBoolParameter	Get a named parameter boolean value.
GetClass	Get the name of the AmbientOcclusionCasterSettings class.
GetDoubleParameter	Get a named parameter floating point value.
GetErrorString	Returns a string describing the error that was found the last time ValidateSettings was performed.
GetIntParameter	Get a named parameter integer value.
GetStringParameter	Get a named parameter string value.
GetUIntParameter	Get a named parameter unsigned integer value.
IsA	Returns true if AmbientOcclusionCasterSettings is a or is a descendant of the class named as the type parameter.
IsNull	Returns true if the AmbientOcclusionCasterSettings object is invalid.
SetBoolParameter	Set a named parameter boolean value.
SetDoubleParameter	Set a named parameter floating point value.
SetIntParameter	Set a named parameter integer value.
SetStringParameter	Set a named parameter string value.
SetUIntParameter	Set a named parameter unsigned integer value.
ToJSON	Get settings as JSON for debugging purposes.
ValidateSettings	Validates the current settings values.

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

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

// Setter
void SetDilation( unsigned int value );

// Getter
unsigned int GetDilation();

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: 0

Syntax

// Setter
void SetDilation(uint value);

// Getter
uint GetDilation();

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: 0

Syntax

# Setter
None SetDilation(value: int)

# Getter
int GetDilation()

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: 0

DitherType

The type of dithering to use when creating the output object.

Syntax

// Setter
void SetDitherType( Simplygon::EDitherPatterns value );

// Getter
Simplygon::EDitherPatterns GetDitherType();

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 Floys-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

Syntax

// Setter
void SetDitherType(enum(EDitherPatterns) value);

// Getter
 GetDitherType();

SetDitherType parameters

Type	Name	Min	Max	Description
EDitherPatterns	value			The desired value of the DitherType to use.

GetDitherType return value

Type: ``````

Default: FloydSteinberg

Key	Value	Comment
NoDither	0	Use no dithering
FloydSteinberg	1	Use Floys-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

Syntax

# Setter
None SetDitherType(value: EDitherPatterns_*)

# Getter
EDitherPatterns_* GetDitherType()

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 Floys-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

// Setter
void SetFillMode( Simplygon::EAtlasFillMode value );

// Getter
Simplygon::EAtlasFillMode GetFillMode();

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

// Setter
void SetFillMode(enum(EAtlasFillMode) value);

// Getter
 GetFillMode();

SetFillMode parameters

Type	Name	Min	Max	Description
EAtlasFillMode	value			The mode to which the fill mode will be set.

GetFillMode return value

Type: ``````

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

# Setter
None SetFillMode(value: EAtlasFillMode_*)

# Getter
EAtlasFillMode_* GetFillMode()

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

// Setter
void SetMaterialChannel( const char * value );

// Getter
spString GetMaterialChannel();

SetMaterialChannel parameters

Type	Name	Min	Max	Description
const char *	value			The input material channel name.

GetMaterialChannel return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetMaterialChannel(string value);

// Getter
string GetMaterialChannel();

SetMaterialChannel parameters

Type	Name	Min	Max	Description
string	value			The input material channel name.

GetMaterialChannel return value

Type: string

Default: null

Syntax

# Setter
None SetMaterialChannel(value: str)

# Getter
str GetMaterialChannel()

SetMaterialChannel parameters

Name	Type	Min	Max	Description
value	str			The input material channel name.

GetMaterialChannel return value

Type: str

Default: None

OcclusionFalloff

How far away a surface has to be from another surface to generate no occlusion. Only applicable if SimpleOcclusionMode is off.

Syntax

// Setter
void SetOcclusionFalloff( real value );

// Getter
real GetOcclusionFalloff();

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

// Setter
void SetOcclusionFalloff(float value);

// Getter
float GetOcclusionFalloff();

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

# Setter
None SetOcclusionFalloff(value: float)

# Getter
float GetOcclusionFalloff()

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

// Setter
void SetOcclusionMultiplier( real value );

// Getter
real GetOcclusionMultiplier();

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

// Setter
void SetOcclusionMultiplier(float value);

// Getter
float GetOcclusionMultiplier();

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

# Setter
None SetOcclusionMultiplier(value: float)

# Getter
float GetOcclusionMultiplier()

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.

Syntax

// Setter
void SetOpacityChannel( const char * value );

// Getter
spString GetOpacityChannel();

SetOpacityChannel parameters

Type	Name	Min	Max	Description
const char *	value			The desired material channel.

GetOpacityChannel return value

Type: spString

Default: Opacity

Syntax

// Setter
void SetOpacityChannel(string value);

// Getter
string GetOpacityChannel();

SetOpacityChannel parameters

Type	Name	Min	Max	Description
string	value			The desired material channel.

GetOpacityChannel return value

Type: string

Default: Opacity

Syntax

# Setter
None SetOpacityChannel(value: str)

# Getter
str GetOpacityChannel()

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

// Setter
void SetOpacityChannelComponent( Simplygon::EColorComponent value );

// Getter
Simplygon::EColorComponent GetOpacityChannelComponent();

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

// Setter
void SetOpacityChannelComponent(enum(EColorComponent) value);

// Getter
 GetOpacityChannelComponent();

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: ``````

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

# Setter
None SetOpacityChannelComponent(value: EColorComponent_*)

# Getter
EColorComponent_* GetOpacityChannelComponent()

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

// Setter
void SetOutputDDSCompressionType( Simplygon::EDDSCompressionType value );

// Getter
Simplygon::EDDSCompressionType GetOutputDDSCompressionType();

SetOutputDDSCompressionType parameters

Type	Name	Min	Max	Description
EDDSCompressionType	value			The desired DDS compression type.

GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key	Value	Comment
NoCompression	-1
BC1	0
BC2	1
BC3	2
BC4	3
BC5	4

Syntax

// Setter
void SetOutputDDSCompressionType(enum(EDDSCompressionType) value);

// Getter
 GetOutputDDSCompressionType();

SetOutputDDSCompressionType parameters

Type	Name	Min	Max	Description
EDDSCompressionType	value			The desired DDS compression type.

GetOutputDDSCompressionType return value

Type: ``````

Default: NoCompression

Key	Value	Comment
NoCompression	-1
BC1	0
BC2	1
BC3	2
BC4	3
BC5	4

Syntax

# Setter
None SetOutputDDSCompressionType(value: EDDSCompressionType_*)

# Getter
EDDSCompressionType_* GetOutputDDSCompressionType()

SetOutputDDSCompressionType parameters

Name	Type	Min	Max	Description
value	EDDSCompressionType			The desired DDS compression type.

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

OutputImageFileFormat

File format for output texture.

Syntax

// Setter
void SetOutputImageFileFormat( Simplygon::EImageOutputFormat value );

// Getter
Simplygon::EImageOutputFormat GetOutputImageFileFormat();

SetOutputImageFileFormat parameters

Type	Name	Min	Max	Description
EImageOutputFormat	value			The desired file format.

GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key	Value	Comment
BMP	0
DDS	1
JPEG	2
PNG	3
TGA	4
TIFF	5

Syntax

// Setter
void SetOutputImageFileFormat(enum(EImageOutputFormat) value);

// Getter
 GetOutputImageFileFormat();

SetOutputImageFileFormat parameters

Type	Name	Min	Max	Description
EImageOutputFormat	value			The desired file format.

GetOutputImageFileFormat return value

Type: ``````

Default: PNG

Key	Value	Comment
BMP	0
DDS	1
JPEG	2
PNG	3
TGA	4
TIFF	5

Syntax

# Setter
None SetOutputImageFileFormat(value: EImageOutputFormat_*)

# Getter
EImageOutputFormat_* GetOutputImageFileFormat()

SetOutputImageFileFormat parameters

Name	Type	Min	Max	Description
value	EImageOutputFormat			The desired file format.

GetOutputImageFileFormat return value

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

OutputPixelFormat

The output pixel format

Syntax

// Setter
void SetOutputPixelFormat( Simplygon::EPixelFormat value );

// Getter
Simplygon::EPixelFormat GetOutputPixelFormat();

SetOutputPixelFormat parameters

Type	Name	Min	Max	Description
EPixelFormat	value			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

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

Syntax

// Setter
void SetOutputPixelFormat(enum(EPixelFormat) value);

// Getter
 GetOutputPixelFormat();

SetOutputPixelFormat parameters

Type	Name	Min	Max	Description
EPixelFormat	value			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

Type: ``````

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

Syntax

# Setter
None SetOutputPixelFormat(value: EPixelFormat_*)

# Getter
EPixelFormat_* GetOutputPixelFormat()

SetOutputPixelFormat parameters

Name	Type	Min	Max	Description
value	EPixelFormat			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

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

RaysPerPixel

This determines how many rays are traced per pixel (or subpixel) to evaluate the occlusion.

Syntax

// Setter
void SetRaysPerPixel( unsigned int value );

// Getter
unsigned int GetRaysPerPixel();

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

// Setter
void SetRaysPerPixel(uint value);

// Getter
uint GetRaysPerPixel();

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

# Setter
None SetRaysPerPixel(value: int)

# Getter
int GetRaysPerPixel()

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

// Setter
void SetUseMultisampling( bool value );

// Getter
bool GetUseMultisampling();

SetUseMultisampling parameters

Type	Name	Min	Max	Description
bool	value			The desired value of the flag.

GetUseMultisampling return value

Type: bool

Default: true

Syntax

// Setter
void SetUseMultisampling(bool value);

// Getter
bool GetUseMultisampling();

SetUseMultisampling parameters

Type	Name	Min	Max	Description
bool	value			The desired value of the flag.

GetUseMultisampling return value

Type: bool

Default: true

Syntax

# Setter
None SetUseMultisampling(value: bool)

# Getter
bool GetUseMultisampling()

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

// Setter
void SetUseSimpleOcclusionMode( bool value );

// Getter
bool GetUseSimpleOcclusionMode();

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

// Setter
void SetUseSimpleOcclusionMode(bool value);

// Getter
bool GetUseSimpleOcclusionMode();

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

# Setter
None SetUseSimpleOcclusionMode(value: bool)

# Getter
bool GetUseSimpleOcclusionMode()

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

GetBoolParameter

Get a named parameter boolean value.

Syntax

bool GetBoolParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: bool

GetClass

Get the name of the AmbientOcclusionCasterSettings class.

Syntax

spString GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetDoubleParameter

Get a named parameter floating point value.

Syntax

double GetDoubleParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: double

Syntax

double GetDoubleParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: double

Syntax

float GetDoubleParameter(name: str)

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

spString GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: spString

Syntax

string GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: string

Syntax

str GetErrorString()

Parameters

GetErrorString takes no parameters.

Return value

Type: str

GetIntParameter

Get a named parameter integer value.

Syntax

int GetIntParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

GetStringParameter

Get a named parameter string value.

Syntax

spString GetStringParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: spString

Syntax

string GetStringParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: string

Syntax

str GetStringParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: str

GetUIntParameter

Get a named parameter unsigned integer value.

Syntax

unsigned int GetUIntParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: unsigned int

Syntax

uint GetUIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: uint

Syntax

int GetUIntParameter(name: str)

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.

Syntax

bool IsA( const char * type );

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

bool IsA(string type);

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

bool IsA(type: str)

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.

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

SetBoolParameter

Set a named parameter boolean value.

Syntax

bool SetBoolParameter( const char * name , bool value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(string name, bool value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(name: str, value: bool)

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

bool SetDoubleParameter( const char * name , double value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(string name, double value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(name: str, value: float)

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

bool SetIntParameter( const char * name , int value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(string name, int value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(name: str, value: int)

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

bool SetStringParameter( const char * name , const char * value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
const char *	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(string name, string value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
string	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(name: str, value: str)

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

bool SetUIntParameter( const char * name , unsigned int value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
unsigned int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(string name, uint value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
uint	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			New value for parameter.

Return value

Type: bool

ToJSON

Get settings as JSON for debugging purposes.

Syntax

spString ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: spString

Syntax

string ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: string

Syntax

str ToJSON()

Parameters

ToJSON takes no parameters.

Return value

Type: str

ValidateSettings

Validates the current settings values.

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings()

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.

Syntax

static bool IsClassA( const char * type );

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

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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.

Syntax

static spAmbientOcclusionCasterSettings SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AmbientOcclusionCasterSettings

Syntax

static spAmbientOcclusionCasterSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: AmbientOcclusionCasterSettings

Syntax

@staticmethod
spAmbientOcclusionCasterSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: AmbientOcclusionCasterSettings