« Zurück zu Produkt

Dokumentation

Farbe

Parameter

Informationen zu den visuellen Eigenschaften und Bedeutungen der Parameter sind in der Objekt-Darstellung zu finden.

Warning

Um alle Parameter der Darstellung nutzen zu können, muss die Variable vom Typ String sein. Ist der Variablentyp Integer so ist die Kodierung fest RGB (0). Weitere Parameter sind für Integer Variablen nicht möglich.

Name Typ Parameter Beschreibung
PRESENTATION String Die ID der Darstellung VARIABLE_PRESENTATION_COLOR
{05CC3CC2-A0B2-5837-A4A7-A07EA0B9DDFB}
ENCODING Integer Kodierung 0: RGB, 1: CMYK, 2: HSV, 3: HSL 4: xy
PRESET_VALUES String Standardwerte JSON-kodierte Liste von Objekten, die genauen Parameter sind unter Farben beschrieben. Nicht verfügbar bei Kodierung xy
COLOR_SPACE Integer Farbraum 0: Benutzerdefiniert, 1: sRGB, 2: AdobeRGB, 3: DCI-P3, 4: Rec2020
CUSTOM_COLOR_SPACE String Benutzerdefinierter Farbraum JSON-kodierte Liste von Objekten, die genauen Parameter sind unter Benutzerdefinierter Farbraum beschrieben
COLOR_CURVE Integer Farbkurve 0: Keine, 1: Benutzerdefiniert, 2: Tageslicht, 3: Tageslicht (Frühling), 4: Tageslicht (Sommer), 5. Tageslicht (Winter)
CUSTOM_COLOR_CURVE String Benutzerdefinierte Farbkurve JSON-kodierte Liste von Objekten, die genauen Parameter sind unter Benutzerdefinierter Farbkurve beschrieben

Farben

Parameter Typ Beschreibung
Color Integer Farbe als Integer

Benutzerdefinierter Farbraum

Ein Farbraum wird durch 4 Objekte mit den Folgenden Parametern beschrieben. Der 1. Eintrag ist dabei für Rot, der 2. für Grün, der 3. für Blau und der 4. für den Weißpunkt.

Parameter Typ Beschreibung
x Float X-Position der Farbe auf der CIE-Normfarbtafel im Bereich 0-1
y Float Y-Position der Farbe auf der CIE-Normfarbtafel im Bereich 0-1

Beispiel:

// sRGB
 [
    {"x":0.64,"y":0.33},
    {"x":0.3,"y":0.6},
    {"x":0.15,"y":0.06},
    {"x":0.3127,"y":0.329}
]

Benutzerdefinierter Farbkurve

Eine Farbkurve besteht aus einer beliebigen Anzahl von Farben, die etwa die Farbtemperatur über den Verlauf eines Tages darstellen.

Parameter Typ Beschreibung
x Float X-Position der Farbe auf der CIE-Normfarbtafel im Bereich 0-1
y Float Y-Position der Farbe auf der CIE-Normfarbtafel im Bereich 0-1

Beispiel:

// Tageslicht (Winter)
 [
          {"x": 0.477, "y" 0.4137},
          {"x": 0.4599, "y" 0.4106},
          {"x": 0.433, "y" 0.4027},
          {"x": 0.4103, "y" 0.3932},
          {"x": 0.3918, "y" 0.3835},
          {"x": 0.3761, "y" 0.374},
          {"x": 0.3631, "y" 0.3652},
          {"x": 0.352, "y" 0.357},
          {"x": 0.3439, "y" 0.3507},
          {"x": 0.3367, "y" 0.3447},
          {"x": 0.3348, "y" 0.343},
]

Vorlagen

// Registriert eine Variable mit grünen Farbtönen als Standardwerte.
$this->RegisterVariableString('Farbe', 'Farbe', [
    'PRESENTATION' => VARIABLE_PRESENTATION_COLOR,
    'TEMPLATE' => VARIABLE_TEMPLATE_COLOR_FOREST,
]);
Name Konstante GUID
Regenbogen VARIABLE_TEMPLATE_COLOR_RAINBOW {0C711895-2F8E-DBFE-1700-84173491D229}
Wald VARIABLE_TEMPLATE_COLOR_FOREST {A7467E68-5C39-5BD9-C0C8-BCE6004FEEAA}

Beispiele

// Beim Registrieren einer Variable für PHP-Module
// Erlaubt die Farbauswahl im Format RGB mit Rot, Grün und Blau als Standardwerte.
$this->RegisterVariableString('FarbeRGB', 'Farbe', [
    'PRESENTATION' => VARIABLE_PRESENTATION_COLOR,
    'ENCODING' => 0 /* RGB */,
    'PRESET_VALUES' => json_encode([['Color' => 16711680], ['Color' => 65280], ['Color' => 255]]),
]);
// Erlaubt die Farbauswahl im Format xy in einem eigenen Farbraum
$this->RegisterVariableString('FarbeXY', 'Farbe', [
    'PRESENTATION' => VARIABLE_PRESENTATION_COLOR,
    'ENCODING' => 4 /* xy*/,
    'COLOR_SPACE' => 0 /* Benutzerdefiniert */,
    'SELECTION' => 1 /* CIE Diagramm */,
    'CUSTOM_COLOR_SPACE' => json_encode([
        ['x' => 0.692, 'y' => 0.308], // Rot
        ['x' => 0.170, 'y' => 0.700], // Grün
        ['x' => 0.153, 'y' => 0.048], // Blau
        ['x' => 0.3127,'y' => 0.329] // Weißpunkt
    ])
]);

// Für bestehende Variablen via Skript
// Erlaubt die Farbauswahl im Format RGB mit Rot, Grün und Blau als Standardwerte.
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_COLOR,
    'ENCODING' => 0 /* RGB */,
    'PRESET_VALUES' => json_encode([['Color' => 16711680], ['Color' => 65280], ['Color' => 255]]),
]);
// Erlaubt die Farbauswahl im Format xy in einem eigenen Farbraum
IPS_SetVariableCustomPresentation(12345, [
    'PRESENTATION' => VARIABLE_PRESENTATION_COLOR,
    'ENCODING' => 4 /* xy*/,
    'COLOR_SPACE' => 0 /* Benutzerdefiniert */,
    'SELECTION' => 1 /* CIE Diagramm */,
    'CUSTOM_COLOR_SPACE' => json_encode([
        ['x' => 0.692, 'y' => 0.308], // Rot
        ['x' => 0.170, 'y' => 0.700], // Grün
        ['x' => 0.153, 'y' => 0.048], // Blau
        ['x' => 0.3127,'y' => 0.329]  // Weißpunkt
    ])
]);
Haben Sie noch Fragen?