Simplygon 10.3.2100.0
class FlipbookSettings
Settings for the ImpostorType: FlipBook
Properties
| Property | Description |
|---|---|
| FlipRowColumnOrder | By default the views are outputted in order of columns then rows. |
| Name | The name of the FlipbookSettings object. (Inherited from Object) |
| NumberOfColumns | Determines the number of columns in the output atlas. If both NumberOfColumns and NumberOfRows are left at zero, the deprecated NumberOfViews will be used instead. |
| NumberOfRows | Determines the number of columns in the output atlas. If both NumberOfColumns and NumberOfRows are left at zero, the deprecated NumberOfViews will be used instead. |
| NumberOfViews | Deprecated: Use NumberOfColumns and NumberOfRows instead. If NumberOfColumns or NumberOfRows are nonzero, they will be used instead. Determines the number of views generated for the flip book impostor. Value has to be a squared number. |
| OutputEachViewSeparately | If enabled will create a MappingImage per view, instead of concatenating them all into the same atlas. Fetch the indexed MappingImages using GetMappingImageForImageIndex() on the ImpostorProcessor. |
| OverrideFlipbookTextureWidth | If OverrideFlipbookTextureWidth is set to a nonzero value it will determine the total width of the texture atlas. The height will be determined by the ratio of NumberOfRows to the NumberOfColumns. If OverrideFlipbookTextureWidth is not set the width and height will be set per flipbook view using SetTextureWidth() in the MappingImageSettings. |
| PivotAroundOrigin | If PivotAroundOrigin is enabled, the Flipbook quad geometry will be centered around the origin instead of the object center to match the pivoted rotation of the original geometry. This creates less optimal texture usage however, and the further the object center is from the origin the larger the texture waste becomes (in the direction away from the object center). Usage example: if the subject is a tree with an off-center trunk base, then flipping between the views will have the base of the trunk moving around. But if the trunk is centered on the origin and PivotAroundOrigin is enabled, the base of the trunk will remain stationary. |
| 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. |
| 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
FlipRowColumnOrder
By default the views are outputted in order of columns then rows.
Name
The name of the FlipbookSettings object. (Inherited from Object)
NumberOfColumns
Determines the number of columns in the output atlas. If both NumberOfColumns and NumberOfRows are left at zero, the deprecated NumberOfViews will be used instead.
NumberOfRows
Determines the number of columns in the output atlas. If both NumberOfColumns and NumberOfRows are left at zero, the deprecated NumberOfViews will be used instead.
NumberOfViews
Deprecated: Use NumberOfColumns and NumberOfRows instead. If NumberOfColumns or NumberOfRows are nonzero, they will be used instead. Determines the number of views generated for the flip book impostor. Value has to be a squared number.
WARNING
This property is marked as deprecated and will be removed in a future version.
Use NumberOfColumns instead.
OutputEachViewSeparately
If enabled will create a MappingImage per view, instead of concatenating them all into the same atlas. Fetch the indexed MappingImages using GetMappingImageForImageIndex() on the ImpostorProcessor.
OverrideFlipbookTextureWidth
If OverrideFlipbookTextureWidth is set to a nonzero value it will determine the total width of the texture atlas. The height will be determined by the ratio of NumberOfRows to the NumberOfColumns. If OverrideFlipbookTextureWidth is not set the width and height will be set per flipbook view using SetTextureWidth() in the MappingImageSettings.
PivotAroundOrigin
If PivotAroundOrigin is enabled, the Flipbook quad geometry will be centered around the origin instead of the object center to match the pivoted rotation of the original geometry. This creates less optimal texture usage however, and the further the object center is from the origin the larger the texture waste becomes (in the direction away from the object center). Usage example: if the subject is a tree with an off-center trunk base, then flipping between the views will have the base of the trunk moving around. But if the trunk is centered on the origin and PivotAroundOrigin is enabled, the base of the trunk will remain stationary.
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.
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 details
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.
GetClass
Get the name of the FlipbookSettings class. (Inherited from Object)
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 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.
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 details
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)