class ImpostorSettings
Settings for the ImpostorProccessor
Properties
| Property | Description |
|---|
| ImpostorType | Specifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView. |
Methods
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.
Syntax
SetImpostorType parameters
| Type | Name | Min | Max | Description |
|---|
| EImpostorType | value | | | The ImpostorType value to use. |
GetImpostorType return value
Type: EImpostorType
Default: BillboardCloud
| 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. |
Syntax
SetImpostorType parameters
| Type | Name | Min | Max | Description |
|---|
| EImpostorType | value | | | The ImpostorType value to use. |
GetImpostorType return value
Type: ``````
Default: BillboardCloud
| 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. |
Syntax
SetImpostorType parameters
| Name | Type | Min | Max | Description |
|---|
| value | EImpostorType | | | The ImpostorType value to use. |
GetImpostorType return value
Type: EImpostorType
Default: BillboardCloud
| 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.
GetClass
Get the name of the ImpostorSettings class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
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
GetFlipbookSettings
The settings for creating the flipbook.
Syntax
Parameters
GetFlipbookSettings takes no parameters.
Return value
Type: FlipbookSettings
Syntax
Parameters
GetFlipbookSettings takes no parameters.
Return value
Type: FlipbookSettings
Syntax
Parameters
GetFlipbookSettings takes no parameters.
Return value
Type: FlipbookSettings
GetImpostorFromSingleViewSettings
The settings for the single view impostor.
IsA
Returns true if ImpostorSettings is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ImpostorSettings 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 ImpostorSettings 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 ImpostorSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ImpostorSettings object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
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.
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 spImpostorSettings, and if this is the case, returns the object cast into spImpostorSettings.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ImpostorSettings
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ImpostorSettings
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ImpostorSettings
