ColorPaletteDivergingHCL¶

This class is a base class for diverging HCL color palettes.

See also

SAMSON API: sbdcolorpalettediverginghcl

class samson.DataModel.Color.ColorPaletteDivergingHCL(*args, **kwargs)¶

Bases: samson.DataModel.Color.ColorPaletteDiverging

This class is a base class for the diverging HCL (Hue-Chroma-Luminance) color palette.

Overloaded function.

__init__(self: samson.DataModel.Color.ColorPaletteDivergingHCL) -> None

Default constructor

__init__(self: samson.DataModel.Color.ColorPaletteDivergingHCL, hue1: int, hue2: int, chroma1: int, maximumChroma: int, luminance1: int, luminance2: int, chromaPower: float, luminancePower: float, neutralPoint: float, name: str) -> None

Constructs a diverging HCL color palette with the given parameters

__init__(self: samson.DataModel.Color.ColorPaletteDivergingHCL, otherColorPalette: samson.DataModel.Color.ColorPaletteDivergingHCL) -> None

Constructs a diverging color palette based on the given diverging HCL color palette

class ColorPaletteType(self: samson.DataModel.Color.ColorPalette.ColorPaletteType, arg0: int) → None¶

Bases: pybind11_builtins.pybind11_object

Members:

Custom

Qualitative

Sequential

Diverging

Custom = ColorPaletteType.Custom¶

Diverging = ColorPaletteType.Diverging¶

Qualitative = ColorPaletteType.Qualitative¶

Sequential = ColorPaletteType.Sequential¶

name¶: (self – handle) -> str

clone(self: samson.DataModel.Color.ColorPalette) → samson.DataModel.Color.ColorPalette¶: Returns a copy of the color palette

getColor(self: samson.DataModel.Color.ColorPalette, arg0: float) → List[float]¶: Returns RGB color based on the palette and an intensity value value which should be in the range [0.0, 1.0]

getColorInPaletteColorSpace(self: samson.DataModel.Color.ColorPalette, arg0: float) → List[float]¶: Returns color coordinates in this palette’s color space for the given intensity value value which should be in the range [0.0, 1.0]

setChroma(self: samson.DataModel.Color.ColorPaletteDiverging, chroma1: int, maximumChroma: int, chromaPower: float = 1.0) → None¶

setHue(self: samson.DataModel.Color.ColorPaletteDiverging, hue1: int, hue2: int) → None¶

setLuminance(self: samson.DataModel.Color.ColorPaletteDiverging, luminance1: int, luminance2: int, luminancePower: float = 1.0) → None¶

Custom = ColorPaletteType.Custom¶

Diverging = ColorPaletteType.Diverging¶

Qualitative = ColorPaletteType.Qualitative¶

Sequential = ColorPaletteType.Sequential¶

chroma1¶

chromaPower¶

hue1¶

hue2¶

isSerializable¶: Returns true when the class is serializable

luminance1¶

luminance2¶

luminancePower¶

maximumChroma¶

name¶: The color palette’s name

neutralPoint¶

type¶: The color palette’s type