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.

Syntax

// Setter
void SetFlipRowColumnOrder( bool value ) const;

// Getter
bool GetFlipRowColumnOrder() const;

SetFlipRowColumnOrder parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetFlipRowColumnOrder return value

Type: bool

Default: false

Syntax

// Setter
void SetFlipRowColumnOrder(bool value);

// Getter
bool GetFlipRowColumnOrder();

SetFlipRowColumnOrder parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetFlipRowColumnOrder return value

Type: bool

Default: false

Syntax

# Setter
None SetFlipRowColumnOrder(value: bool)

# Getter
bool GetFlipRowColumnOrder()

SetFlipRowColumnOrder parameters

Name	Type	Min	Max	Description
value	bool			The new value.

GetFlipRowColumnOrder return value

Type: bool

Default: false

Name

The name of the FlipbookSettings object. (Inherited from Object)

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

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.

Syntax

// Setter
void SetNumberOfColumns( unsigned int value ) const;

// Getter
unsigned int GetNumberOfColumns() const;

SetNumberOfColumns parameters

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

GetNumberOfColumns return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetNumberOfColumns(uint value);

// Getter
uint GetNumberOfColumns();

SetNumberOfColumns parameters

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

GetNumberOfColumns return value

Type: uint

Default: 0

Syntax

# Setter
None SetNumberOfColumns(value: int)

# Getter
int GetNumberOfColumns()

SetNumberOfColumns parameters

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

GetNumberOfColumns return value

Type: int

Default: 0

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.

Syntax

// Setter
void SetNumberOfRows( unsigned int value ) const;

// Getter
unsigned int GetNumberOfRows() const;

SetNumberOfRows parameters

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

GetNumberOfRows return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetNumberOfRows(uint value);

// Getter
uint GetNumberOfRows();

SetNumberOfRows parameters

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

GetNumberOfRows return value

Type: uint

Default: 0

Syntax

# Setter
None SetNumberOfRows(value: int)

# Getter
int GetNumberOfRows()

SetNumberOfRows parameters

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

GetNumberOfRows return value

Type: int

Default: 0

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.

Syntax

// Setter
SGDEPRECATED void SetNumberOfViews( unsigned int value ) const;

// Getter
SGDEPRECATED unsigned int GetNumberOfViews() const;

SetNumberOfViews parameters

Type	Name	Min	Max	Description
unsigned int	value	0	64	The new value, has to be a squared 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, has to be a squared 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, has to be a squared value.

GetNumberOfViews return value

Type: int

Default: 9

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.

Syntax

// Setter
void SetOutputEachViewSeparately( bool value ) const;

// Getter
bool GetOutputEachViewSeparately() const;

SetOutputEachViewSeparately parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetOutputEachViewSeparately return value

Type: bool

Default: false

Syntax

// Setter
void SetOutputEachViewSeparately(bool value);

// Getter
bool GetOutputEachViewSeparately();

SetOutputEachViewSeparately parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetOutputEachViewSeparately return value

Type: bool

Default: false

Syntax

# Setter
None SetOutputEachViewSeparately(value: bool)

# Getter
bool GetOutputEachViewSeparately()

SetOutputEachViewSeparately parameters

Name	Type	Min	Max	Description
value	bool			The new value.

GetOutputEachViewSeparately return value

Type: bool

Default: false

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.

Syntax

// Setter
void SetOverrideFlipbookTextureWidth( unsigned int value ) const;

// Getter
unsigned int GetOverrideFlipbookTextureWidth() const;

SetOverrideFlipbookTextureWidth parameters

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

GetOverrideFlipbookTextureWidth return value

Type: unsigned int

Default: 0

Syntax

// Setter
void SetOverrideFlipbookTextureWidth(uint value);

// Getter
uint GetOverrideFlipbookTextureWidth();

SetOverrideFlipbookTextureWidth parameters

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

GetOverrideFlipbookTextureWidth return value

Type: uint

Default: 0

Syntax

# Setter
None SetOverrideFlipbookTextureWidth(value: int)

# Getter
int GetOverrideFlipbookTextureWidth()

SetOverrideFlipbookTextureWidth parameters

Name	Type	Min	Max	Description
value	int	0	65536	The new value.

GetOverrideFlipbookTextureWidth return value

Type: int

Default: 0

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.

Syntax

// Setter
void SetPivotAroundOrigin( bool value ) const;

// Getter
bool GetPivotAroundOrigin() const;

SetPivotAroundOrigin parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetPivotAroundOrigin return value

Type: bool

Default: false

Syntax

// Setter
void SetPivotAroundOrigin(bool value);

// Getter
bool GetPivotAroundOrigin();

SetPivotAroundOrigin parameters

Type	Name	Min	Max	Description
bool	value			The new value.

GetPivotAroundOrigin return value

Type: bool

Default: false

Syntax

# Setter
None SetPivotAroundOrigin(value: bool)

# Getter
bool GetPivotAroundOrigin()

SetPivotAroundOrigin parameters

Name	Type	Min	Max	Description
value	bool			The new value.

GetPivotAroundOrigin return value

Type: bool

Default: false

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 ) const;

// Getter
spRealData GetUpVector() const;

SetUpVector parameters

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

GetUpVector return value

Type: spRealData

Default: 0,1,0

Syntax

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

// Getter
spRealData GetUpVector();

SetUpVector parameters

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

GetUpVector return value

Type: spRealData

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 ) const;

// Getter
real GetUpVectorX() const;

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 ) const;

// Getter
real GetUpVectorY() const;

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 ) const;

// Getter
real GetUpVectorZ() const;

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

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 ) const;

// Getter
spRealData GetViewDirection() const;

SetViewDirection parameters

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

GetViewDirection return value

Type: spRealData

Default: 1,0,0

Syntax

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

// Getter
spRealData GetViewDirection();

SetViewDirection parameters

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

GetViewDirection return value

Type: spRealData

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 ) const;

// Getter
real GetViewDirectionX() const;

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 ) const;

// Getter
real GetViewDirectionY() const;

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 ) const;

// Getter
real GetViewDirectionZ() const;

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

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

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

bool GetBoolParameter( const char * name ) const;

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. (Inherited from Object)

Syntax

spString GetClass() const;

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 ) const;

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() const;

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 ) const;

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 ) const;

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 ) const;

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. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

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. (Inherited from Object)

Syntax

bool IsNull() const;

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

IsSameObjectAs

Returns true if the FlipbookSettings object is valid. (Inherited from Object)

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

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

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

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

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

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

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

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 ) const;

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 ) const;

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 ) const;

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 ) const;

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 ) const;

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() const;

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() const;

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. (Inherited from Object)

Syntax

static bool IsClassA( const char * type ) const;

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. (Inherited from Object)

Syntax

static spFlipbookSettings SafeCast( const spObject & object ) const;

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