# class GeometryCullingSettings

Settings for volumetric triangle culling functionality. These settings control the clipping planes and geometries that are used for triangle culling the output of Simplygon scene processors.

# Properties

Property Description
ClippingGeometrySelectionSetID Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
ClippingGeometrySelectionSetName Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.
ClippingPlaneSelectionSetID Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
ClippingPlaneSelectionSetName Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.
UseClippingGeometry If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries.
UseClippingPlanes If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh.

# Methods

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

# Properties details

# ClippingGeometrySelectionSetID

Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.

    # ClippingGeometrySelectionSetName

    Which SelectionSet containing geometries will be used for clipping. Set name is prioritized over id if both are set.

      # ClippingPlaneSelectionSetID

      Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.

        # ClippingPlaneSelectionSetName

        Which SelectionSet containing sceneplanes will be used for clipping. Set name is prioritized over id if both are set.

          # UseClippingGeometry

          If set, the geometries defined in the matching selection set will be used to clip the process geometry. What side of the geometry that will be culled is determined by the triangle facing, so make sure your winding is correct and that triangles point "up" toward the space you want to keep. Inconsistent triangle winding or meshes that do not have a clear local inside and outside will cause inconsistent results when used as clipping geometries.

            # UseClippingPlanes

            If true the ScenePlanes in the input scene (or the planes selected by the selection set settings) will be used to clip the mesh.

              # Methods details

              # GetBoolParameter

              Get a named parameter boolean value.

                # GetClass

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

                              # IsNull

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