Simplygon 9 Documentation

# 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 billboard count. When this criteria is met, it is not guaranteed that all triangles in the scene have been accurately mapped to a billboard yet. Triangles that have not been mapped to a billboard within the BillboardMaxDeviation distance will be mapped to an existing billboard that best represents the triangle.
TwoSided Only applicable if BillboardMode: Foliage. Determines if the scene is intended to be viewed from both sides without back face culling.
UseVisibilityWeights Determines whether to prioritize accurately mapping triangles with higher visibility to billboards.

# Methods

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the BillboardCloudSettings 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.
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.
IsNull Returns true if the BillboardCloudSettings 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.
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 spBillboardCloudSettings, and if this is the case, returns the object cast into spBillboardCloudSettings.

# 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 billboard count. When this criteria is met, it is not guaranteed that all triangles in the scene have been accurately mapped to a billboard yet. Triangles that have not been mapped to a billboard within the BillboardMaxDeviation distance will be mapped to an existing billboard that best represents the triangle.

            # TwoSided

            Only applicable if BillboardMode: Foliage. Determines if the scene is intended to be viewed from both sides without back face culling.

              # UseVisibilityWeights

              Determines whether to prioritize accurately mapping triangles with higher visibility to billboards.

                # Methods details

                # GetBoolParameter

                Get a named parameter boolean value.

                  # GetClass

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

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

                                  # IsNull

                                  Returns true if the BillboardCloudSettings 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.

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

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

                                                      ← BoneSettings →