class FlipbookSettings
Settings for the ImpostorType: FlipBook
Properties
| Property | Description |
|---|
| Name | The name of the FlipbookSettings object. (Inherited from Object) |
| NumberOfViews | Determines the number of views generated for the flip book impostor. |
| UpVector | The views are rotated around the up vector and the rendered images are oriented with the up vector. |
| UpVectorX | The views are rotated around the up vector and the rendered images are oriented with the up vector. |
| UpVectorY | The views are rotated around the up vector and the rendered images are oriented with the up vector. |
| UpVectorZ | The views are rotated around the up vector and the rendered images are oriented with the up vector. |
| VerticalAngle | Deprecated: Use ViewDirection and UpVector instead. |
| ViewDirection | This vector determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction. |
| ViewDirectionX | The X component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction. |
| ViewDirectionY | The Y component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction. |
| ViewDirectionZ | The Z component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the FlipbookSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if FlipbookSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the FlipbookSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the FlipbookSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the FlipbookSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the FlipbookSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| 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. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| 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. (Inherited from Object) |
Properties details
Name
The name of the FlipbookSettings object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
NumberOfViews
Determines the number of views generated for the flip book impostor.
Syntax
SetNumberOfViews parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | 0 | 64 | The new value. |
GetNumberOfViews return value
Type: unsigned int
Default: 9
Syntax
SetNumberOfViews parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | 0 | 64 | The new value. |
GetNumberOfViews return value
Type: uint
Default: 9
Syntax
SetNumberOfViews parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | 0 | 64 | The new value. |
GetNumberOfViews return value
Type: int
Default: 9
UpVector
The views are rotated around the up vector and the rendered images are oriented with the up vector.
Syntax
SetUpVector parameters
| Type | Name | Min | Max | Description |
|---|
RealData | value | | | The new up vector. |
GetUpVector return value
Type: RealData
Default: 0,1,0
Syntax
SetUpVector parameters
| Type | Name | Min | Max | Description |
|---|
float[] | value | | | The new up vector. |
GetUpVector return value
Type: RealData
Default: 0,1,0
Syntax
SetUpVector parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The new up vector. |
GetUpVector return value
Type: float
Default: 0,1,0
UpVectorX
The views are rotated around the up vector and the rendered images are oriented with the up vector.
Syntax
SetUpVectorX parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new up vector X component. |
GetUpVectorX return value
Type: real
Default: 0
Syntax
SetUpVectorX parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new up vector X component. |
GetUpVectorX return value
Type: float
Default: 0
Syntax
SetUpVectorX parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new up vector X component. |
GetUpVectorX return value
Type: float
Default: 0
UpVectorY
The views are rotated around the up vector and the rendered images are oriented with the up vector.
Syntax
SetUpVectorY parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new up vector Y component. |
GetUpVectorY return value
Type: real
Default: 1
Syntax
SetUpVectorY parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new up vector Y component. |
GetUpVectorY return value
Type: float
Default: 1
Syntax
SetUpVectorY parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new up vector Y component. |
GetUpVectorY return value
Type: float
Default: 1
UpVectorZ
The views are rotated around the up vector and the rendered images are oriented with the up vector.
Syntax
SetUpVectorZ parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new up vector Z component. |
GetUpVectorZ return value
Type: real
Default: 0
Syntax
SetUpVectorZ parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new up vector Z component. |
GetUpVectorZ return value
Type: float
Default: 0
Syntax
SetUpVectorZ parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new up vector Z component. |
GetUpVectorZ return value
Type: float
Default: 0
VerticalAngle
Deprecated: Use ViewDirection and UpVector instead.
WARNING
This property is marked as deprecated and will be removed in a future version.
Use ViewDirection instead.
Syntax
SetVerticalAngle parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -90 | 90 | The new value. |
GetVerticalAngle return value
Type: real
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
ViewDirection
This vector determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
Syntax
SetViewDirection parameters
| Type | Name | Min | Max | Description |
|---|
RealData | value | | | The new view vector. |
GetViewDirection return value
Type: RealData
Default: 1,0,0
Syntax
SetViewDirection parameters
| Type | Name | Min | Max | Description |
|---|
float[] | value | | | The new view vector. |
GetViewDirection return value
Type: RealData
Default: 1,0,0
Syntax
SetViewDirection parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The new view vector. |
GetViewDirection return value
Type: float
Default: 1,0,0
ViewDirectionX
The X component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
Syntax
SetViewDirectionX parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new view vector X component. |
GetViewDirectionX return value
Type: real
Default: 1
Syntax
SetViewDirectionX parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new view vector X component. |
GetViewDirectionX return value
Type: float
Default: 1
Syntax
SetViewDirectionX parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new view vector X component. |
GetViewDirectionX return value
Type: float
Default: 1
ViewDirectionY
The Y component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
Syntax
SetViewDirectionY parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new view vector Y component. |
GetViewDirectionY return value
Type: real
Default: 0
Syntax
SetViewDirectionY parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new view vector Y component. |
GetViewDirectionY return value
Type: float
Default: 0
Syntax
SetViewDirectionY parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new view vector Y component. |
GetViewDirectionY return value
Type: float
Default: 0
ViewDirectionZ
The Z component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
Syntax
SetViewDirectionZ parameters
| Type | Name | Min | Max | Description |
|---|
real | value | -REAL_MAX | REAL_MAX | The new view vector Z component. |
GetViewDirectionZ return value
Type: real
Default: 0
Syntax
SetViewDirectionZ parameters
| Type | Name | Min | Max | Description |
|---|
float | value | -REAL_MAX | REAL_MAX | The new view vector Z component. |
GetViewDirectionZ return value
Type: float
Default: 0
Syntax
SetViewDirectionZ parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | -REAL_MAX | REAL_MAX | The new view vector Z component. |
GetViewDirectionZ return value
Type: float
Default: 0
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the FlipbookSettings class. (Inherited from Object)
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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
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
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
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if FlipbookSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
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. (Inherited from Object)
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
IsSameObjectAs
Returns true if the FlipbookSettings object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the FlipbookSettings object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the FlipbookSettings object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
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
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
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. (Inherited from Object)
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. (Inherited from Object)
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
