# class ChartAggregatorSettings

Settings for the chart aggregator.

# Properties

Property Description
ChartAggregatorMode Determines which method to use when aggregating the UVs. TextureSizeProportions - Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea - Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity - The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions - Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.
LockUVRotation Only used when the TexCoordGeneratorType is ChartAggregator. If ChartAggregatorLockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations).
Name The name of the ChartAggregatorSettings object. (Inherited from Object)
OriginalChartProportionsChannel Only used when the TexCoordGeneratorType is ChartAggregator. Set ChartAggregatorKeepOriginalChartProportionsFromChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart proportions to keep.
OriginalTexCoordLevel Only used when the TexCoordGeneratorType is ChartAggregator. Set the texture coordinate level to get charts from. If the ChartAggregatorOriginalTexCoordName ha been set, the ChartAggregatorOriginalTexCoordLevel is not used.
OriginalTexCoordName Only used when the TexCoordGeneratorType is ChartAggregator. Set the name of the texture coordinate level to get charts from. If not set, it will use the ChartAggregatorOriginalTexCoordLevel (index) instead.
SeparateOverlappingCharts Only used when the TexCoordGeneratorType is ChartAggregator. If set, charts that are overlapping in the original texture coords will be separated.
SurfaceAreaScale If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

# 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 ChartAggregatorSettings 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 ChartAggregatorSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the ChartAggregatorSettings object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the ChartAggregatorSettings object is valid. (Inherited from Object)
NonNull Returns true if the ChartAggregatorSettings object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the ChartAggregatorSettings 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 spChartAggregatorSettings, and if this is the case, returns the object cast into spChartAggregatorSettings. (Inherited from Object)

# Properties details

# ChartAggregatorMode

Determines which method to use when aggregating the UVs. TextureSizeProportions - Aggregated UV charts will be scaled to keep their relative pixel density relative to all other UV charts. The user can still set the size of the output texture maps. SurfaceArea - Aggregated UV charts will have their size set based on its actual geometrical size. OriginalPixelDensity - The combined atlas will be resized to fit each chart so that all charts retain the same amount of pixels as they originally had. This will override any manually set texture size. UVSizeProportions - Aggregated UV charts will have their size set based on its original UV size, disregarding the size of the texture they are used in.

    # LockUVRotation

    Only used when the TexCoordGeneratorType is ChartAggregator. If ChartAggregatorLockUVRotation is enabled, only the original UV rotation will be used. Otherwise 4 rotations are used (90 degree rotations).

      # Name

      The name of the ChartAggregatorSettings object. (Inherited from Object)

        # OriginalChartProportionsChannel

        Only used when the TexCoordGeneratorType is ChartAggregator. Set ChartAggregatorKeepOriginalChartProportionsFromChannel to an SG_MATERIAL_CHANNEL_[...]. This channel determines which texture channel to look at when determining which chart proportions to keep.

          # OriginalTexCoordLevel

          Only used when the TexCoordGeneratorType is ChartAggregator. Set the texture coordinate level to get charts from. If the ChartAggregatorOriginalTexCoordName ha been set, the ChartAggregatorOriginalTexCoordLevel is not used.

            # OriginalTexCoordName

            Only used when the TexCoordGeneratorType is ChartAggregator. Set the name of the texture coordinate level to get charts from. If not set, it will use the ChartAggregatorOriginalTexCoordLevel (index) instead.

              # SeparateOverlappingCharts

              Only used when the TexCoordGeneratorType is ChartAggregator. If set, charts that are overlapping in the original texture coords will be separated.

                # SurfaceAreaScale

                If multiple UV charts overlap and have the same material, SurfaceAreaScale specifies which of those instances determines the the output scale. It is only valid when the ChartAggregatorMode is SurfaceArea and SeparateOverlappingCharts is false.

                  # 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 ChartAggregatorSettings 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 ChartAggregatorSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

                                    # IsNull

                                    Returns true if the ChartAggregatorSettings object is invalid. (Inherited from Object)

                                      # IsSameObjectAs

                                      Returns true if the ChartAggregatorSettings object is valid. (Inherited from Object)

                                        # NonNull

                                        Returns true if the ChartAggregatorSettings object is valid. (Inherited from Object)

                                          # PrintInfo

                                          Prints the content/info of the ChartAggregatorSettings 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 spChartAggregatorSettings, and if this is the case, returns the object cast into spChartAggregatorSettings. (Inherited from Object)