Simplygon 9 Documentation

# class ImpostorSettings

Settings for the ImpostorProccessor

# Properties

Property Description
ImpostorType Specifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView.
ProcessSelectionSetID Which selection set should be processed. If set to -1, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.
ProcessSelectionSetName Which selection set should be processed. If the name is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.

# Methods

Method Description
GetBillboardCloudSettings The settings for creating the billboard cloud.
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the ImpostorSettings 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.
GetFlipbookSettings The settings for creating the flipbook.
GetImpostorFromSingleViewSettings The settings for the single view impostor.
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 ImpostorSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ImpostorSettings 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 spImpostorSettings, and if this is the case, returns the object cast into spImpostorSettings.

# Properties details

# ImpostorType

Specifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView.

# Syntax

// Setter
void SetImpostorType( Simplygon::EImpostorType value );

// Getter
Simplygon::EImpostorType GetImpostorType();

# SetImpostorType parameters

Type Name Min Max Description
EImpostorType value The ImpostorType value to use.

# GetImpostorType return value

Type: EImpostorType

Default: BillboardCloud

Key Value Comment
BillboardCloud 0 Generates a set of billboards that represents the scene.
Flipbook 1 Renders the scene from a number of views and generates an atlas with the images.
FromSingleView 3 Generates an impostor from a single view.

# ProcessSelectionSetID

Which selection set should be processed. If set to -1, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.

# Syntax

// Setter
void SetProcessSelectionSetID( rid value );

// Getter
rid GetProcessSelectionSetID();

# SetProcessSelectionSetID parameters

Type Name Min Max Description
rid value -1 The desired SelectionSet id.

# GetProcessSelectionSetID return value

Type: rid

Default: -1

# ProcessSelectionSetName

Which selection set should be processed. If the name is not found, all geometries in the scene will be processed. If both selection set name and ID are set, the name will be used.

# Syntax

// Setter
void SetProcessSelectionSetName( const char * value );

// Getter
spString GetProcessSelectionSetName();

# SetProcessSelectionSetName parameters

Type Name Min Max Description
const char * value The desired SelectionSet name.

# GetProcessSelectionSetName return value

Type: spString

Default: nullptr

# Methods details

# GetBillboardCloudSettings

The settings for creating the billboard cloud.

# Syntax

spBillboardCloudSettings GetBillboardCloudSettings();

# Parameters

GetBillboardCloudSettings takes no parameters.

# Return value

Type: BillboardCloudSettings

# 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

# GetClass

Get the name of the ImpostorSettings class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# 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

# 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

# GetFlipbookSettings

The settings for creating the flipbook.

# Syntax

spFlipbookSettings GetFlipbookSettings();

# Parameters

GetFlipbookSettings takes no parameters.

# Return value

Type: FlipbookSettings

# GetImpostorFromSingleViewSettings

The settings for the single view impostor.

# Syntax

spImpostorFromSingleViewSettings GetImpostorFromSingleViewSettings();

# Parameters

GetImpostorFromSingleViewSettings takes no parameters.

# Return value

Type: ImpostorFromSingleViewSettings

# 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

# 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

# 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

# IsA

Returns true if ImpostorSettings 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 ImpostorSettings is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the ImpostorSettings object is invalid.

# 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

# 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

# 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

# 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

# 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

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

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON();

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

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

# Syntax

static spImpostorSettings SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ImpostorSettings

← MappingImageInputMaterialSettings →