Simplygon 9 Documentation

# class OcclusionMeshSettings

Settings for occlusion meshes

# Properties

Property Description
CameraSelectionSetId The camera selection set id. This determines the selection set used for the cameras for when UseCameras is on. A value of -1 uses all cameras in the scene.
CameraSelectionSetName The camera selection set name. This determines the selection set used for the cameras for when UseCameras is on. If set to null, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used.
InvertOutputMesh Flips the winding of the triangles of the output, making frontfaces backfaces and vice versa. Good for conservative z testing.
OcclusionMode The occlusion mode. This decides if the processor generates an occluder (which is smaller than the original mesh), an ocludee (which is larger), or an output that just tries to match the input.
OnScreenErrorTolerance The OnScreenErrorTolerance determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.
OnScreenSize The onscreen size (px) of the output utility mesh. This will determine triangle count and quality.
TransferSkinning Sets whether to transfer the bone weights and bone ids to the new geometry.
UseCameras If set, cameras from the input scene will be used to define what angles the occlusion mesh can be visible from, and optimize the output mesh accordingly. Otherwise, the occlusion mesh will be assumed to be viewable from all directions.

# Methods

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

# Properties details

# CameraSelectionSetId

The camera selection set id. This determines the selection set used for the cameras for when UseCameras is on. A value of -1 uses all cameras in the scene.

    # CameraSelectionSetName

    The camera selection set name. This determines the selection set used for the cameras for when UseCameras is on. If set to null, all cameras in the scene will be used. If both selection set name and ID are set, the name will be used.

      # InvertOutputMesh

      Flips the winding of the triangles of the output, making frontfaces backfaces and vice versa. Good for conservative z testing.

        # OcclusionMode

        The occlusion mode. This decides if the processor generates an occluder (which is smaller than the original mesh), an ocludee (which is larger), or an output that just tries to match the input.

          # OnScreenErrorTolerance

          The OnScreenErrorTolerance determines how large of an error that is tolerated, in pixels. Valid range is 1-50. Since this setting is based around the absolute worst-case scenario, you can usually get good results at relatively high tolerances.

            # OnScreenSize

            The onscreen size (px) of the output utility mesh. This will determine triangle count and quality.

              # TransferSkinning

              Sets whether to transfer the bone weights and bone ids to the new geometry.

                # UseCameras

                If set, cameras from the input scene will be used to define what angles the occlusion mesh can be visible from, and optimize the output mesh accordingly. Otherwise, the occlusion mesh will be assumed to be viewable from all directions.

                  # Methods details

                  # GetBoolParameter

                  Get a named parameter boolean value.

                    # GetClass

                    Get the name of the OcclusionMeshSettings 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 OcclusionMeshSettings is a or is a descendant of the class named as the type parameter.

                                  # IsNull

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

                                                        ← OpacityCasterSettings →