class FoliageSettings

Settings for the BillboardMode: Foliage

Properties

Property	Description
SeparateFoliageAreaThreshold	Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the surface area is below (SeparateFoliageAreaThreshold * AreaOfTheLargestGroupInTheScene) it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the maximum surface area means everything will be foliage.
SeparateFoliageSizeThreshold	Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the diameter of the group is below (SeparateFoliageSizeThreshold * SceneDiameter) it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the scene's diameter means everything will be foliage.
SeparateFoliageTriangleRatio	Is used to separate the trunk from the foliage in a vegetation scene by comparing each group of connected triangles in the scene with the scene's largest group. If a group's triangle count is below SeparateFoliageTriangleRatio * largestGrouptriangleCount it is treated as foliage and processed into billboards. The trunk is optimized using triangle reduction. The range is 0.0->1.0. 0.0 means nothing will be foliage, 1.0 means everything will be foliage.
SeparateFoliageTriangleThreshold	Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the triangle count is below SeparateFoliageTriangleThreshold it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the maximum triangle count means everything will be foliage.
SeparateTrunkAndFoliage	Determines whether to enable separation between foliage and trunk in a vegetation scene. Use the SeparateFoliage[...] settings to determine how parts are separated.
TrunkReductionRatio	Determines the triangle reduction ratio for the trunk part that has been separated from the foliage part based on the "separate foliage" settings.

Methods

Method	Description
GetBoolParameter	Get a named parameter boolean value.
GetClass	Get the name of the FoliageSettings 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 FoliageSettings is a or is a descendant of the class named as the type parameter.
IsNull	Returns true if the FoliageSettings 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.
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.
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 spFoliageSettings, and if this is the case, returns the object cast into spFoliageSettings.

Properties details

SeparateFoliageAreaThreshold

Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the surface area is below (SeparateFoliageAreaThreshold * AreaOfTheLargestGroupInTheScene) it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the maximum surface area means everything will be foliage.

Syntax

// Setter
void SetSeparateFoliageAreaThreshold( real value );

// Getter
real GetSeparateFoliageAreaThreshold();

SetSeparateFoliageAreaThreshold parameters

Type	Name	Min	Max	Description
real	value	0	REAL_MAX	The new value.

GetSeparateFoliageAreaThreshold return value

Type: real

Default: 0.1

Syntax

// Setter
void SetSeparateFoliageAreaThreshold(float value);

// Getter
float GetSeparateFoliageAreaThreshold();

SetSeparateFoliageAreaThreshold parameters

Type	Name	Min	Max	Description
float	value	0	REAL_MAX	The new value.

GetSeparateFoliageAreaThreshold return value

Type: float

Default: 0.1

Syntax

# Setter
None SetSeparateFoliageAreaThreshold(value: float)

# Getter
float GetSeparateFoliageAreaThreshold()

SetSeparateFoliageAreaThreshold parameters

Name	Type	Min	Max	Description
value	float	0	REAL_MAX	The new value.

GetSeparateFoliageAreaThreshold return value

Type: float

Default: 0.1

SeparateFoliageSizeThreshold

Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the diameter of the group is below (SeparateFoliageSizeThreshold * SceneDiameter) it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the scene's diameter means everything will be foliage.

Syntax

// Setter
void SetSeparateFoliageSizeThreshold( real value );

// Getter
real GetSeparateFoliageSizeThreshold();

SetSeparateFoliageSizeThreshold parameters

Type	Name	Min	Max	Description
real	value	0	REAL_MAX	The new value.

GetSeparateFoliageSizeThreshold return value

Type: real

Default: 0.1

Syntax

// Setter
void SetSeparateFoliageSizeThreshold(float value);

// Getter
float GetSeparateFoliageSizeThreshold();

SetSeparateFoliageSizeThreshold parameters

Type	Name	Min	Max	Description
float	value	0	REAL_MAX	The new value.

GetSeparateFoliageSizeThreshold return value

Type: float

Default: 0.1

Syntax

# Setter
None SetSeparateFoliageSizeThreshold(value: float)

# Getter
float GetSeparateFoliageSizeThreshold()

SetSeparateFoliageSizeThreshold parameters

Name	Type	Min	Max	Description
value	float	0	REAL_MAX	The new value.

GetSeparateFoliageSizeThreshold return value

Type: float

Default: 0.1

SeparateFoliageTriangleRatio

Is used to separate the trunk from the foliage in a vegetation scene by comparing each group of connected triangles in the scene with the scene's largest group. If a group's triangle count is below SeparateFoliageTriangleRatio * largestGrouptriangleCount it is treated as foliage and processed into billboards. The trunk is optimized using triangle reduction. The range is 0.0->1.0. 0.0 means nothing will be foliage, 1.0 means everything will be foliage.

Syntax

// Setter
void SetSeparateFoliageTriangleRatio( real value );

// Getter
real GetSeparateFoliageTriangleRatio();

SetSeparateFoliageTriangleRatio parameters

Type	Name	Min	Max	Description
real	value	0.0	1.0	The new value.

GetSeparateFoliageTriangleRatio return value

Type: real

Default: 0.01

Syntax

// Setter
void SetSeparateFoliageTriangleRatio(float value);

// Getter
float GetSeparateFoliageTriangleRatio();

SetSeparateFoliageTriangleRatio parameters

Type	Name	Min	Max	Description
float	value	0.0	1.0	The new value.

GetSeparateFoliageTriangleRatio return value

Type: float

Default: 0.01

Syntax

# Setter
None SetSeparateFoliageTriangleRatio(value: float)

# Getter
float GetSeparateFoliageTriangleRatio()

SetSeparateFoliageTriangleRatio parameters

Name	Type	Min	Max	Description
value	float	0.0	1.0	The new value.

GetSeparateFoliageTriangleRatio return value

Type: float

Default: 0.01

SeparateFoliageTriangleThreshold

Is used to separate the trunk from the foliage in a vegetation scene by finding each group of connected triangles in the scene and if the triangle count is below SeparateFoliageTriangleThreshold it is treated as foliage and processed into billboards. The trunk is optimized using reduction. The range is 0->large value. 0 means nothing will be foliage, value larger than the maximum triangle count means everything will be foliage.

Syntax

// Setter
void SetSeparateFoliageTriangleThreshold( unsigned int value );

// Getter
unsigned int GetSeparateFoliageTriangleThreshold();

SetSeparateFoliageTriangleThreshold parameters

Type	Name	Min	Max	Description
unsigned int	value	0	UINT_MAX	The new value.

GetSeparateFoliageTriangleThreshold return value

Type: unsigned int

Default: 10

Syntax

// Setter
void SetSeparateFoliageTriangleThreshold(uint value);

// Getter
uint GetSeparateFoliageTriangleThreshold();

SetSeparateFoliageTriangleThreshold parameters

Type	Name	Min	Max	Description
uint	value	0	UINT_MAX	The new value.

GetSeparateFoliageTriangleThreshold return value

Type: uint

Default: 10

Syntax

# Setter
None SetSeparateFoliageTriangleThreshold(value: int)

# Getter
int GetSeparateFoliageTriangleThreshold()

SetSeparateFoliageTriangleThreshold parameters

Name	Type	Min	Max	Description
value	int	0	UINT_MAX	The new value.

GetSeparateFoliageTriangleThreshold return value

Type: int

Default: 10

SeparateTrunkAndFoliage

Determines whether to enable separation between foliage and trunk in a vegetation scene. Use the SeparateFoliage[...] settings to determine how parts are separated.

Syntax

// Setter
void SetSeparateTrunkAndFoliage( bool value );

// Getter
bool GetSeparateTrunkAndFoliage();

SetSeparateTrunkAndFoliage parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetSeparateTrunkAndFoliage return value

Type: bool

Default: false

Syntax

// Setter
void SetSeparateTrunkAndFoliage(bool value);

// Getter
bool GetSeparateTrunkAndFoliage();

SetSeparateTrunkAndFoliage parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetSeparateTrunkAndFoliage return value

Type: bool

Default: false

Syntax

# Setter
None SetSeparateTrunkAndFoliage(value: bool)

# Getter
bool GetSeparateTrunkAndFoliage()

SetSeparateTrunkAndFoliage parameters

Name	Type	Min	Max	Description
value	bool			The new value.

GetSeparateTrunkAndFoliage return value

Type: bool

Default: false

TrunkReductionRatio

Determines the triangle reduction ratio for the trunk part that has been separated from the foliage part based on the "separate foliage" settings.

Syntax

// Setter
void SetTrunkReductionRatio( real value );

// Getter
real GetTrunkReductionRatio();

SetTrunkReductionRatio parameters

Type	Name	Min	Max	Description
real	value	0.0	1.0	The new value.

GetTrunkReductionRatio return value

Type: real

Default: 0.5

Syntax

// Setter
void SetTrunkReductionRatio(float value);

// Getter
float GetTrunkReductionRatio();

SetTrunkReductionRatio parameters

Type	Name	Min	Max	Description
float	value	0.0	1.0	The new value.

GetTrunkReductionRatio return value

Type: float

Default: 0.5

Syntax

# Setter
None SetTrunkReductionRatio(value: float)

# Getter
float GetTrunkReductionRatio()

SetTrunkReductionRatio parameters

Name	Type	Min	Max	Description
value	float	0.0	1.0	The new value.

GetTrunkReductionRatio return value

Type: float

Default: 0.5

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 FoliageSettings 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 FoliageSettings 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 FoliageSettings 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 FoliageSettings 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 FoliageSettings is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the FoliageSettings 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

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

void SetValidateParameterNames( bool validate );

Parameters

Type	Name	Min	Max	Description
bool	validate			Flag indicating if validation is performed or not.

Syntax

void SetValidateParameterNames(bool validate);

Parameters

Type	Name	Min	Max	Description
bool	validate			Flag indicating if validation is performed or not.

Syntax

None SetValidateParameterNames(validate: bool)

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

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

Syntax

static spFoliageSettings SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: FoliageSettings

Syntax

static spFoliageSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: FoliageSettings

Syntax

@staticmethod
spFoliageSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: FoliageSettings