Simplygon 9 Documentation

# class ImpostorFromSingleViewSettings

Settings for the ImpostorType: ImpostorFromSingleView.

# Properties

Property Description
TexCoordPadding Normally, the processor will generate an impostor with texcoords from 0.0 to 1.0, giving perfect UV coverage in the final texture. If your engine uses permanent tiling rendering mode, you may need to add a small padding to avoid sub-pixel wrapping artifact at the impostor edges, which this setting supplies. Ex: Setting this to 0.01 will generate texcoords in the range 0.01 to 0.99.
TightFittingDepthOffset This determines where the impostor will end up in depth. 0 is "center", 1 is "front" and -1 is "back".
TwoSided If set, the impostor will contain both front and back facing surfaces.
UseTightFitting If set, the impostor will exactly conform to the bounds of the geometry. If false, its dimensions will always be diameter*diameter.
ViewDirection This vector determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.
ViewDirectionX The X component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.
ViewDirectionY The Y component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.
ViewDirectionZ The Z component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

# Methods

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the ImpostorFromSingleViewSettings 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 ImpostorFromSingleViewSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ImpostorFromSingleViewSettings 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 spImpostorFromSingleViewSettings, and if this is the case, returns the object cast into spImpostorFromSingleViewSettings.

# Properties details

# TexCoordPadding

Normally, the processor will generate an impostor with texcoords from 0.0 to 1.0, giving perfect UV coverage in the final texture. If your engine uses permanent tiling rendering mode, you may need to add a small padding to avoid sub-pixel wrapping artifact at the impostor edges, which this setting supplies. Ex: Setting this to 0.01 will generate texcoords in the range 0.01 to 0.99.

# Syntax

// Setter
void SetTexCoordPadding( real value );

// Getter
real GetTexCoordPadding();

# SetTexCoordPadding parameters

Type Name Min Max Description
real value 0.0 0.5 The desired value TexCoordPadding will be set to.

# GetTexCoordPadding return value

Type: real

Default: 0.0

# TightFittingDepthOffset

This determines where the impostor will end up in depth. 0 is "center", 1 is "front" and -1 is "back".

# Syntax

// Setter
void SetTightFittingDepthOffset( real value );

// Getter
real GetTightFittingDepthOffset();

# SetTightFittingDepthOffset parameters

Type Name Min Max Description
real value -1.0 1.0 The desired value TightFittingDepthOffset will be set to.

# GetTightFittingDepthOffset return value

Type: real

Default: 0.0

# TwoSided

If set, the impostor will contain both front and back facing surfaces.

# Syntax

// Setter
void SetTwoSided( bool value );

// Getter
bool GetTwoSided();

# SetTwoSided parameters

Type Name Min Max Description
bool value The new TwoSided value.

# GetTwoSided return value

Type: bool

Default: false

# UseTightFitting

If set, the impostor will exactly conform to the bounds of the geometry. If false, its dimensions will always be diameter*diameter.

# Syntax

// Setter
void SetUseTightFitting( bool value );

// Getter
bool GetUseTightFitting();

# SetUseTightFitting parameters

Type Name Min Max Description
bool value The value UseTightFitting will be set to.

# GetUseTightFitting return value

Type: bool

Default: false

# ViewDirection

This vector determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

# 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: 0,0,1

# ViewDirectionX

The X component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

# 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: 0

# ViewDirectionY

The Y component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

# 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

# ViewDirectionZ

The Z component of the ViewDirection vector. The ViewDirection determines how the resulting impostor geometry will be oriented. The billboard will be perpendicular to this vector.

# 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: 1

# 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

# GetClass

Get the name of the ImpostorFromSingleViewSettings 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

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

# Return value

Type: bool

# IsNull

Returns true if the ImpostorFromSingleViewSettings 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 spImpostorFromSingleViewSettings, and if this is the case, returns the object cast into spImpostorFromSingleViewSettings.

# Syntax

static spImpostorFromSingleViewSettings SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ImpostorFromSingleViewSettings

← ImpostorSettings →