class FlipbookSettings

Settings for the ImpostorType: FlipBook

Properties

Property	Description
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
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.

Syntax

// Setter
void SetNumberOfViews( unsigned int value );

// Getter
unsigned int GetNumberOfViews();

SetNumberOfViews parameters

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

GetNumberOfViews return value

Type: unsigned int

Default: 9

Syntax

// Setter
void SetNumberOfViews(uint value);

// Getter
uint GetNumberOfViews();

SetNumberOfViews parameters

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

GetNumberOfViews return value

Type: uint

Default: 9

Syntax

# Setter
None SetNumberOfViews(value: int)

# Getter
int GetNumberOfViews()

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

// Setter
void SetUpVector( const real *value_realInputDataPtr );

// Getter
spRealData GetUpVector();

SetUpVector parameters

Type	Name	Min	Max	Description
RealData	value			The new up vector.

GetUpVector return value

Type: RealData

Default: 0,1,0

Syntax

// Setter
void SetUpVector(float[] value);

// Getter
RealData GetUpVector();

SetUpVector parameters

Type	Name	Min	Max	Description
float[]	value			The new up vector.

GetUpVector return value

Type: RealData

Default: 0,1,0

Syntax

# Setter
None SetUpVector(value: float)

# Getter
spRealData GetUpVector()

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

// Setter
void SetUpVectorX( real value );

// Getter
real GetUpVectorX();

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

// Setter
void SetUpVectorX(float value);

// Getter
float GetUpVectorX();

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

# Setter
None SetUpVectorX(value: float)

# Getter
float GetUpVectorX()

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

// Setter
void SetUpVectorY( real value );

// Getter
real GetUpVectorY();

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

// Setter
void SetUpVectorY(float value);

// Getter
float GetUpVectorY();

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

# Setter
None SetUpVectorY(value: float)

# Getter
float GetUpVectorY()

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

// Setter
void SetUpVectorZ( real value );

// Getter
real GetUpVectorZ();

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

// Setter
void SetUpVectorZ(float value);

// Getter
float GetUpVectorZ();

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

# Setter
None SetUpVectorZ(value: float)

# Getter
float GetUpVectorZ()

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

// Setter
SGDEPRECATED void SetVerticalAngle( real value );

// Getter
SGDEPRECATED real GetVerticalAngle();

SetVerticalAngle parameters

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

GetVerticalAngle return value

Type: real

Default: 0

Syntax

// Setter
void SetVerticalAngle(float value);

// Getter
float GetVerticalAngle();

SetVerticalAngle parameters

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

GetVerticalAngle return value

Type: float

Default: 0

Syntax

# Setter
None SetVerticalAngle(value: float)

# Getter
float GetVerticalAngle()

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

// Setter
void SetViewDirection( const real *value_realInputDataPtr );

// Getter
spRealData GetViewDirection();

SetViewDirection parameters

Type	Name	Min	Max	Description
RealData	value			The new view vector.

GetViewDirection return value

Type: RealData

Default: 1,0,0

Syntax

// Setter
void SetViewDirection(float[] value);

// Getter
RealData GetViewDirection();

SetViewDirection parameters

Type	Name	Min	Max	Description
float[]	value			The new view vector.

GetViewDirection return value

Type: RealData

Default: 1,0,0

Syntax

# Setter
None SetViewDirection(value: float)

# Getter
spRealData GetViewDirection()

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

// Setter
void SetViewDirectionX( real value );

// Getter
real GetViewDirectionX();

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

// Setter
void SetViewDirectionX(float value);

// Getter
float GetViewDirectionX();

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

# Setter
None SetViewDirectionX(value: float)

# Getter
float GetViewDirectionX()

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

// Setter
void SetViewDirectionY( real value );

// Getter
real GetViewDirectionY();

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

// Setter
void SetViewDirectionY(float value);

// Getter
float GetViewDirectionY();

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

# Setter
None SetViewDirectionY(value: float)

# Getter
float GetViewDirectionY()

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

// Setter
void SetViewDirectionZ( real value );

// Getter
real GetViewDirectionZ();

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

// Setter
void SetViewDirectionZ(float value);

// Getter
float GetViewDirectionZ();

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

# Setter
None SetViewDirectionZ(value: float)

# Getter
float GetViewDirectionZ()

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

GetBoolParameter

Get a named parameter boolean value.

Syntax

bool GetBoolParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: bool

GetClass

Get the name of the FlipbookSettings class.

Syntax

spString GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetDoubleParameter

Get a named parameter floating point value.

Syntax

double GetDoubleParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: double

Syntax

double GetDoubleParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: double

Syntax

float GetDoubleParameter(name: str)

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

spString GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: spString

Syntax

string GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: string

Syntax

str GetErrorString()

Parameters

GetErrorString takes no parameters.

Return value

Type: str

GetIntParameter

Get a named parameter integer value.

Syntax

int GetIntParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

GetStringParameter

Get a named parameter string value.

Syntax

spString GetStringParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: spString

Syntax

string GetStringParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: string

Syntax

str GetStringParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: str

GetUIntParameter

Get a named parameter unsigned integer value.

Syntax

unsigned int GetUIntParameter( const char * name );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: unsigned int

Syntax

uint GetUIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: uint

Syntax

int GetUIntParameter(name: str)

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.

Syntax

bool IsA( const char * type );

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

bool IsA(string type);

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

bool IsA(type: str)

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

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

SetBoolParameter

Set a named parameter boolean value.

Syntax

bool SetBoolParameter( const char * name , bool value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(string name, bool value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(name: str, value: bool)

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

bool SetDoubleParameter( const char * name , double value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(string name, double value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(name: str, value: float)

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

bool SetIntParameter( const char * name , int value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(string name, int value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(name: str, value: int)

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

bool SetStringParameter( const char * name , const char * value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
const char *	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(string name, string value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
string	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(name: str, value: str)

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

bool SetUIntParameter( const char * name , unsigned int value );

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
unsigned int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(string name, uint value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
uint	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(name: str, value: int)

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

void SetValidateParameterNames( bool validate );

Parameters

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

Syntax

void SetValidateParameterNames(bool validate);

Parameters

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

Syntax

None SetValidateParameterNames(validate: bool)

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

spString ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: spString

Syntax

string ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: string

Syntax

str ToJSON()

Parameters

ToJSON takes no parameters.

Return value

Type: str

ValidateSettings

Validates the current settings values.

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings()

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

static bool IsClassA( const char * type );

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

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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

static spFlipbookSettings SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: FlipbookSettings

Syntax

static spFlipbookSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: FlipbookSettings

Syntax

@staticmethod
spFlipbookSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: FlipbookSettings