# 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
GetClass Get the name of the FlipbookSettings class.
GetErrorString Returns a string describing the error that was found the last time ValidateSettings was performed.
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.
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 The new value.

# GetNumberOfViews return value

Type: unsigned int

Default: 9

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

# 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

# Methods details

# GetClass

Get the name of the FlipbookSettings class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# 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

# 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

# IsNull

Returns true if the FlipbookSettings object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# ValidateSettings

Validates the current settings values.

# 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

# 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