# `class` ImpostorSettings

Settings for the ImpostorProccessor

# Properties

Property	Description
ImpostorType	Specifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView.

# Methods

Method	Description
GetBillboardCloudSettings	The settings for creating the billboard cloud.
GetBoolParameter	Get a named parameter boolean value.
GetClass	Get the name of the ImpostorSettings 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.
GetFlipbookSettings	The settings for creating the flipbook.
GetImpostorFromSingleViewSettings	The settings for the single view impostor.
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 ImpostorSettings is a or is a descendant of the class named as the type parameter.
IsNull	Returns true if the ImpostorSettings 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 spImpostorSettings, and if this is the case, returns the object cast into spImpostorSettings.

# Properties details

# ImpostorType

Specifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView.

Type	Name	Min	Max	Description
EImpostorType	value			The ImpostorType value to use.

Key	Value	Comment
BillboardCloud	0	Generates a set of billboards that represents the scene.
Flipbook	1	Renders the scene from a number of views and generates an atlas with the images.
FromSingleView	3	Generates an impostor from a single view.

Type	Name	Min	Max	Description
EImpostorType	value			The ImpostorType value to use.

Key	Value	Comment
BillboardCloud	0	Generates a set of billboards that represents the scene.
Flipbook	1	Renders the scene from a number of views and generates an atlas with the images.
FromSingleView	3	Generates an impostor from a single view.

Name	Type	Min	Max	Description
value	EImpostorType			The ImpostorType value to use.

Key	Value	Comment
EImpostorType_BillboardCloud	0	Generates a set of billboards that represents the scene.
EImpostorType_Flipbook	1	Renders the scene from a number of views and generates an atlas with the images.
EImpostorType_FromSingleView	3	Generates an impostor from a single view.

# Methods details

# GetBillboardCloudSettings

The settings for creating the billboard cloud.

# GetBoolParameter

Get a named parameter boolean value.

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

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

# GetClass

Get the name of the ImpostorSettings class.

# GetDoubleParameter

Get a named parameter floating point value.

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

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

# GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

# GetFlipbookSettings

The settings for creating the flipbook.

# GetImpostorFromSingleViewSettings

The settings for the single view impostor.

# GetIntParameter

Get a named parameter integer value.

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

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

# GetStringParameter

Get a named parameter string value.

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

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

# GetUIntParameter

Get a named parameter unsigned integer value.

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

Type	Name	Min	Max	Description
`string`	name			Parameter name.

Name	Type	Min	Max	Description
name	`str`			Parameter name.

# IsA

Returns true if ImpostorSettings is a or is a descendant of the class named as the type parameter.

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if ImpostorSettings is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if ImpostorSettings is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ImpostorSettings is, or is a descendant of.

# IsNull

Returns true if the ImpostorSettings object is invalid.

# SetBoolParameter

Set a named parameter boolean value.

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

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

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

# SetDoubleParameter

Set a named parameter floating point value.

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

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

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

# SetIntParameter

Set a named parameter integer value.

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

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

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

# SetStringParameter

Set a named parameter string value.

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

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

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

# SetUIntParameter

Set a named parameter unsigned integer value.

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

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

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

# ToJSON

Get settings as JSON for debugging purposes.

# ValidateSettings

Validates the current settings values.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spImpostorSettings, and if this is the case, returns the object cast into spImpostorSettings.

Type	Name	Min	Max	Description
`Object`	object			Object to cast.

Type	Name	Min	Max	Description
`Object`	object			Object to cast.

Name	Type	Min	Max	Description
object	`Object`			Object to cast.

← ImpostorFromSingleViewSettings MappingImageInputMaterialSettings →

# class ImpostorSettings