Simplygon 10.2.10100.0
class BillboardCloudSettings
Settings for the ImpostorType: BillboardCloud
Properties
| Property | Description |
|---|---|
| BillboardDensity | Determines how many billboards to create. A large BillboardDensity means that more billboards will be created to represent spatially spread out triangles better. Having a low BillboardDensity means that fewer billboards will be created and the distances from original leaves to billboards will get larger. The range is 0->1. |
| BillboardMode | Specifies how the impostors should be mapped to the scene. |
| FavorVerticalPlanes | Determines whether to prioritize generating vertical billboards which means they will be optimized to be viewed from the side. Otherwise, if the geometry in the input scene is mostly facing upwards/downwards then the generated billboards will also be facing upwards/downwards which makes them not well suited to being viewed from the side. |
| GeometricComplexity | Determines the geometric complexity of the billboards. The value range is 0->1, where a value of Zero means that the billboards will be simple and not follow the projection closely. And a value of One means that the geometric complexity will be increased and follow the projection closely. |
| MaxPlaneCount | Determines the maximum amount of planes that are computed for the scene initially. When this criteria is met, it is not guaranteed that all triangles in the scene have been accurately mapped to a billboard. It is not a definite hard limit on the number of billboards because the planes can be split up into multiple planes when they're being cut to match their projections. For instance: if GeometricComplexity is high and there are two completely separated projections on a billboard, then the billboard will be split up into two billboards. |
| Name | The name of the BillboardCloudSettings object. (Inherited from Object) |
| OpacityChannel | Determines which input material channel to use for opacity. Some standard material channels are defined as SG_MATERIAL_CHANNEL_[ CHANNEL ] but arbitrary names for user created channels works also. |
| OpacityChannelComponent | The component in the opacity channel to use as opacity value. |
| OpacityCutoff | The value that compared with the opacity value determines if the surface is either opaque or transparent. |
| TwoSided | Only applicable if BillboardMode: Foliage. Determines if the scene is intended to be viewed from both sides without back face culling. |
| UpVector | The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality. |
| UpVectorX | The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality. |
| UpVectorY | The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality. |
| UpVectorZ | The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality. |
| UseVisibilityWeights | Determines whether to prioritize accurately mapping triangles with higher visibility to billboards. |
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 BillboardCloudSettings 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) |
| GetFoliageSettings | Settings for foliage when BillboardMode is Foliage. |
| 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 BillboardCloudSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the BillboardCloudSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the BillboardCloudSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the BillboardCloudSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the BillboardCloudSettings 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 spBillboardCloudSettings, and if this is the case, returns the object cast into spBillboardCloudSettings. (Inherited from Object) |
Properties details
BillboardDensity
Determines how many billboards to create. A large BillboardDensity means that more billboards will be created to represent spatially spread out triangles better. Having a low BillboardDensity means that fewer billboards will be created and the distances from original leaves to billboards will get larger. The range is 0->1.
BillboardMode
Specifies how the impostors should be mapped to the scene.
FavorVerticalPlanes
Determines whether to prioritize generating vertical billboards which means they will be optimized to be viewed from the side. Otherwise, if the geometry in the input scene is mostly facing upwards/downwards then the generated billboards will also be facing upwards/downwards which makes them not well suited to being viewed from the side.
GeometricComplexity
Determines the geometric complexity of the billboards. The value range is 0->1, where a value of Zero means that the billboards will be simple and not follow the projection closely. And a value of One means that the geometric complexity will be increased and follow the projection closely.
MaxPlaneCount
Determines the maximum amount of planes that are computed for the scene initially. When this criteria is met, it is not guaranteed that all triangles in the scene have been accurately mapped to a billboard. It is not a definite hard limit on the number of billboards because the planes can be split up into multiple planes when they're being cut to match their projections. For instance: if GeometricComplexity is high and there are two completely separated projections on a billboard, then the billboard will be split up into two billboards.
Name
The name of the BillboardCloudSettings object. (Inherited from Object)
OpacityChannel
Determines which input material channel to use for opacity. Some standard material channels are defined as SG_MATERIAL_CHANNEL_[ CHANNEL ] but arbitrary names for user created channels works also.
OpacityChannelComponent
The component in the opacity channel to use as opacity value.
OpacityCutoff
The value that compared with the opacity value determines if the surface is either opaque or transparent.
TwoSided
Only applicable if BillboardMode: Foliage. Determines if the scene is intended to be viewed from both sides without back face culling.
UpVector
The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality.
UpVectorX
The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality.
UpVectorY
The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality.
UpVectorZ
The UpVector used in the Billboard Cloud Processor. Set this if the input scene has an up vector other than Y+. If FavorVerticalPlanes is enabled, the UpVector determines verticality.
UseVisibilityWeights
Determines whether to prioritize accurately mapping triangles with higher visibility to billboards.
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 BillboardCloudSettings 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.
GetFoliageSettings
Settings for foliage when BillboardMode is Foliage.
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 BillboardCloudSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the BillboardCloudSettings object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the BillboardCloudSettings object is valid. (Inherited from Object)
NonNull
Returns true if the BillboardCloudSettings object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the BillboardCloudSettings 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 spBillboardCloudSettings, and if this is the case, returns the object cast into spBillboardCloudSettings. (Inherited from Object)