Simplygon 10.3.2100.0
class ImpostorFromSingleViewSettings
Settings for the ImpostorType: ImpostorFromSingleView.
Properties
| Property | Description |
|---|---|
| Name | The name of the ImpostorFromSingleViewSettings object. (Inherited from Object) |
| OverrideCenter | If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor. |
| OverrideCenterX | The X component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor. |
| OverrideCenterY | The Y component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor. |
| OverrideCenterZ | The Z component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor. |
| OverrideRadius | If UseOverrideCenterAndRadius is enabled, the OverrideRadius value determines the size of the impostor. If OverrideRadius is equal to 0 then the radius will be automatically calculated internally to contain the entire scene. |
| 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. |
| UseOverrideCenterAndRadius | If UseOverrideCenterAndRadius is enabled, the OverrideCenter and OverrideRadius determine the center and size of the impostor. |
| 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 |
|---|---|
| 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 ImpostorFromSingleViewSettings 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 ImpostorFromSingleViewSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ImpostorFromSingleViewSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ImpostorFromSingleViewSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the ImpostorFromSingleViewSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ImpostorFromSingleViewSettings 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 spImpostorFromSingleViewSettings, and if this is the case, returns the object cast into spImpostorFromSingleViewSettings. (Inherited from Object) |
Properties details
Name
The name of the ImpostorFromSingleViewSettings object. (Inherited from Object)
OverrideCenter
If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor.
OverrideCenterX
The X component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor.
OverrideCenterY
The Y component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor.
OverrideCenterZ
The Z component of the OverrideCenter vector. If UseOverrideCenterAndRadius is enabled, the OverrideCenter value will determine the center for the impostor.
OverrideRadius
If UseOverrideCenterAndRadius is enabled, the OverrideRadius value determines the size of the impostor. If OverrideRadius is equal to 0 then the radius will be automatically calculated internally to contain the entire scene.
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.
UseOverrideCenterAndRadius
If UseOverrideCenterAndRadius is enabled, the OverrideCenter and OverrideRadius determine the center and size of the impostor.
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 details
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.
GetClass
Get the name of the ImpostorFromSingleViewSettings 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.
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. (Inherited from Object)
IsNull
Returns true if the ImpostorFromSingleViewSettings object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the ImpostorFromSingleViewSettings object is valid. (Inherited from Object)
NonNull
Returns true if the ImpostorFromSingleViewSettings object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the ImpostorFromSingleViewSettings 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 spImpostorFromSingleViewSettings, and if this is the case, returns the object cast into spImpostorFromSingleViewSettings. (Inherited from Object)