# `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
GetBoolParameter	Get a named parameter boolean value.
GetClass	Get the name of the FlipbookSettings 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.
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.
IsNull	Returns true if the FlipbookSettings 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.
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

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.

Type	Name	Min	Max	Description
`unsigned int`	value	0	64	The new value.

Type	Name	Min	Max	Description
`uint`	value	0	64	The new value.

Name	Type	Min	Max	Description
value	`int`	0	64	The new value.

# 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.

Type	Name	Min	Max	Description
`real`	value	-90	90	The new value.

Type	Name	Min	Max	Description
`float`	value	-90	90	The new value.

Name	Type	Min	Max	Description
value	`float`	-90	90	The new value.

# Methods details

# 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 FlipbookSettings 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.

# 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 FlipbookSettings 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 FlipbookSettings is, or is a descendant of.

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

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

# IsNull

Returns true if the FlipbookSettings 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.

# 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.

Type	Name	Min	Max	Description
`bool`	validate			Flag indicating if validation is performed or not.

Type	Name	Min	Max	Description
`bool`	validate			Flag indicating if validation is performed or not.

Name	Type	Min	Max	Description
validate	`bool`			Flag indicating if validation is performed or not.

# 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 spFlipbookSettings, and if this is the case, returns the object cast into spFlipbookSettings.

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

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

← DisplacementCasterSettings FoliageSettings →

# class FlipbookSettings