class FlipbookSettings
Settings for the ImpostorType: FlipBook
Properties
| Property | Description |
| NumberOfViews | Determines the number of views generated for the flip book impostor. |
| VerticalAngle | Determines the vertical angle in degrees of the views to generate for the flip book impostor. 0 degrees: Looking horizontally at the scene. 90 degrees: Looking at the scene from above. -90 degrees: Looking at the scene from below. |
Methods
| Method | Description |
| GetClass | Get the name of the FlipbookSettings class. |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. |
| IsA | Returns true if FlipbookSettings is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the FlipbookSettings object is invalid. |
| 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 spFlipbookSettings, and if this is the case, returns the object cast into spFlipbookSettings. |
Properties details
NumberOfViews
Determines the number of views generated for the flip book impostor.
Syntax
SetNumberOfViews parameters
| Type | Name | Min | Max | Description |
unsigned int | value | | | The new value. |
GetNumberOfViews return value
Type: unsigned int
Default: 9
Syntax
SetNumberOfViews parameters
| Type | Name | Min | Max | Description |
uint | value | | | The new value. |
GetNumberOfViews return value
Type: uint
Default: 9
Syntax
SetNumberOfViews parameters
| Name | Type | Min | Max | Description |
| value | int | | | The new value. |
GetNumberOfViews return value
Type: int
Default: 9
VerticalAngle
Determines the vertical angle in degrees of the views to generate for the flip book impostor. 0 degrees: Looking horizontally at the scene. 90 degrees: Looking at the scene from above. -90 degrees: Looking at the scene from below.
Syntax
SetVerticalAngle parameters
| Type | Name | Min | Max | Description |
float | value | -90 | 90 | The new value. |
GetVerticalAngle return value
Type: float
Default: 0
Syntax
SetVerticalAngle parameters
| Type | Name | Min | Max | Description |
float | value | -90 | 90 | The new value. |
GetVerticalAngle return value
Type: float
Default: 0
Syntax
SetVerticalAngle parameters
| Name | Type | Min | Max | Description |
| value | float | -90 | 90 | The new value. |
GetVerticalAngle return value
Type: float
Default: 0
Methods details
GetClass
Get the name of the FlipbookSettings 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
IsA
Returns true if FlipbookSettings 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 FlipbookSettings 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 FlipbookSettings 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 FlipbookSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the FlipbookSettings 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 spFlipbookSettings, and if this is the case, returns the object cast into spFlipbookSettings.
Syntax
Parameters
| Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: FlipbookSettings
Syntax
Parameters
| Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: FlipbookSettings
Syntax
Parameters
| Name | Type | Min | Max | Description |
| object | Object | | | Object to cast. |
Return value
Type: FlipbookSettings