Skip to content
On this page

class ImpostorSettings

Settings for the ImpostorProcessor

Properties

PropertyDescription
ImpostorTypeSpecifies which type of impostor should be created: BillboardCloud, Flipbook or ImpostorFromSingleView.
NameThe name of the ImpostorSettings object. (Inherited from Object)
ProcessSelectionSetIDWhich 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.
ProcessSelectionSetNameWhich 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

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBillboardCloudSettingsThe settings for creating the billboard cloud.
GetBoolParameterGet a named parameter boolean value. (Inherited from SettingsObject)
GetClassGet the name of the ImpostorSettings class. (Inherited from Object)
GetDoubleParameterGet a named parameter floating point value. (Inherited from SettingsObject)
GetErrorStringReturns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetFlipbookSettingsThe settings for creating the flipbook.
GetImpostorFromSingleViewSettingsThe settings for the single view impostor.
GetIntParameterGet a named parameter integer value. (Inherited from SettingsObject)
GetStringParameterGet a named parameter string value. (Inherited from SettingsObject)
GetUIntParameterGet a named parameter unsigned integer value. (Inherited from SettingsObject)
IsAReturns true if ImpostorSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ImpostorSettings object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ImpostorSettings object is valid. (Inherited from Object)
NonNullReturns true if the ImpostorSettings object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ImpostorSettings object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetBoolParameterSet a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameterSet a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameterSet a named parameter integer value. (Inherited from SettingsObject)
SetStringParameterSet a named parameter string value. (Inherited from SettingsObject)
SetUIntParameterSet a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNamesSet 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)
ToJSONGet settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettingsValidates the current settings values. (Inherited from SettingsObject)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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. (Inherited from Object)

Properties details

ImpostorType

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

Name

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

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 details

AddObserver

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

GetBillboardCloudSettings

The settings for creating the billboard cloud.

GetBoolParameter

Get a named parameter boolean value.

GetClass

Get the name of the ImpostorSettings class. (Inherited from Object)

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

IsNull

Returns true if the ImpostorSettings object is invalid. (Inherited from Object)

IsSameObjectAs

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

NonNull

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

PrintInfo

Prints the content/info of the ImpostorSettings object to the log. (Inherited from Object)

RemoveObserver

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

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 details

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 spImpostorSettings, and if this is the case, returns the object cast into spImpostorSettings. (Inherited from Object)