Benutzeroberflächenanmerkung
Verwenden Sie diese Anmerkung, um einem Benutzeroberflächensteuerelement in der Hostumgebung einen Effect-Parameter zuzuordnen. Dadurch kann ein Benutzer einen Effect-Parameter interaktiv über die Hostanwendung steuern.
DXSAS definiert eine Reihe von Standardsteuerelementen im Hinblick auf das Datenmodell und das grundlegende Verhalten, die Autoren von Hostanwendungen erwarten können. Die Steuerelementanmerkung wird wie folgt verwendet:
string SasUiControl = "ControlType";
where
ControlType
ist einer der folgenden Werte:
| ControlType | Beschreibung | Interner Datentyp | Steuerelementeigenschaftenanmerkungen |
|---|---|---|---|
| Keine | Es sollte kein Steuerelement angezeigt werden. Beachten Sie, dass ein Steuerelement sichtbar ist, wenn SasUiVisible true ist und der Steuerelementtyp ein anderer Typ als None ist. | – | – |
| Beliebig | Dies bedeutet, dass kein spezielles Steuerelement angefordert wird. Das dargestellte Steuerelement ist das Ergebnis eines anwendungsdefiniertes Verhaltens. | – | – |
| ColorPicker | Stellen Sie einen Farbwert als Farbwatch dar. Der Wert wird in die XYZ-Komponenten des zugeordneten Vektors gepackt. Die W-Komponente des zugeordneten Vektors ist immer auf 1 festgelegt. | float N, wobei N 1 bis 4 einschließlich ist. | SasUiEnum |
| Richtung | Ein Richtungsvektor. | float N, wobei N 2 bis 4 einschließlich ist. | Keine |
| FilePicker | Ein Dialogfeld, in dem der Benutzer eine Datei durchsuchen und auswählen kann. | Zeichenfolge | Keine |
| ListPicker | Eine Liste von Zeichenfolgenwerten, aus denen der Benutzer einen Eintrag auswählen kann. Die Werte werden aus der SasUiEnum-Anmerkung generiert. | Ein Array von Zeichenfolgen zusammen mit einem ganzzahligen Wert, der den Index des ausgewählten Zeichenfolgenwerts enthält. | SasUiEnum |
| Numeric | Eine Reihe numerischer Eingabesteuerelemente (z. B. Textfelder). | float M x N, wobei M und N 1 bis 4 einschließlich sind. | SasUiMin, SasUiMax, SasUiStride |
| Schieberegler | Eine Reihe von Schiebereglern. | float M x N, wobei M und N 1 bis 4 einschließlich sind | SasUiMin, SasUiMax, SasUiSteps, SasUiStepsPower |
| String | Ein Textfeld zum Bearbeiten von Zeichenfolgeninhalten. | Zeichenfolge | Keine |
Wenn der interne Datentyp nicht mit dem Typ des zugeordneten Parameters identisch ist, erfolgt die Umwandlung, wenn Daten vom Hostanwendungsparameter in den Effect-Parameter übertragen werden.
Der Standardwert ist die Zeichenfolge "None".
Allgemeine Eigenschaften der Benutzeroberfläche
SasUiDescription
Verwenden Sie diese Anmerkung, um eine Zeichenfolge zum Beschreiben eines Tools anzugeben. Dies kann für Benutzeroberflächenelemente wie QuickInfos verwendet werden.
string SasUiDescription = "descriptive string";
Zum Beispiel:
float3 UpNormal
<
string SasUiDescription = "The normalized up vector";
>;
Der Standardwert ist eine leere Zeichenfolge.
SasUiLabel
Verwenden Sie diese Anmerkung, um eine Zeichenfolge zum Bezeichnen eines beliebigen Ui-Steuerelements anzugeben.
string SasUiLabel = "some label;
Beispiel:
float3 UpNormal
<
string SasUiLabel = "Normal that points up.";
>;
Der Standardwert ist eine leere Zeichenfolge.
SasUiVisible
Verwenden Sie diese Anmerkung, um anzugeben, ob der zugeordnete Parameter dem Benutzer angezeigt werden soll.
bool SasUiVisible = false;
Wenn true festgelegt ist, sollte die Hostanwendung ein UI-Steuerelement zum Bearbeiten des Parameters mit Anmerkungen anzeigen. False gibt an, dass in der Hostanwendung keine Benutzeroberfläche angezeigt wird.
Beispiel:
float3 UpNormal
<
string SasUiVisible = false;
>;
Der Standardwert ist True.
Eigenschaften des UI-Steuerelements
Steuerelementeigenschaftenanmerkungen sind zusätzliche Modifizierer, mit denen bestimmt werden kann, wie ein bestimmtes Steuerelement funktioniert.
SasUiEnum
Mit dieser Anmerkung können Sie den Wertebereich für ein Steuerelement einschränken. Die Anmerkung enthält eine Zeichenfolge von Werten, die durch Kommas getrennt sind.
Der Standardwert ist eine leere Zeichenfolge.
SasUiMax
Diese Anmerkung gibt den maximalen Wert des zugeordneten Parameters an. Sie kann nur einem numerisch typisierten Parameter zugeordnet werden. Der Höchstwert des Parameters wird tatsächlich wie folgt berechnet:
MaxValue = min(FLT_MAX, PARAMETER_TYPE_MAX);
PARAMETER _ TYPE MAX ist der _ Höchstwert für den Typ, der vom zugeordneten Parameter verwendet wird. Dies bedeutet, dass der Wert des Parameters unter Berücksichtigung der SasUiMax-Anmerkung wie folgt berechnet wird:
ParameterValue = min(NewParameterValue, MaxValue);
Der Standardwert ist FLT _ MAX, wie in Math.h definiert.
SasUiMin
Diese Anmerkung gibt den Minimalwert des zugeordneten Parameters an. Sie kann nur einem numerisch typisierten Parameter zugeordnet werden. Der Mindestwert des Parameters wird tatsächlich wie folgt berechnet:
MinValue = max(-FLT_MAX, PARAMETER_TYPE_MIN);
PARAMETER _ TYPE MIN ist der _ Mindestwert für den Typ, der vom zugeordneten Parameter verwendet wird. Dies bedeutet, dass der Wert des Parameters unter Berücksichtigung der SasUiMin-Anmerkung wie folgt berechnet wird:
ParameterValue = max(NewParameterValue, MinValue);
Der Standardwert ist -FLT _ MAX, wie in Math.h definiert.
SasUiSteps
Diese Anmerkung gibt die Anzahl der Schritte an, die beim Erhöhen oder Dekrementieren des zugeordneten Parameterwerts verwendet werden können. Die Anmerkung ist nur für einen numerisch typisierten Parameter aussagekräftig. 0 (null) gibt an, dass die Hostanwendung eine angemessene Anzahl von Schritten ausgibt.
Der Standardwert ist 0.
SasUiStepsPower
Diese Anmerkung gibt den Exponenten in der Power-Funktion an, die den Bereich [ 0,0f, 1,0f ] hat. Hostanwendungen müssen beim Berechnen von Parameterwerten die folgende Methode implementieren:
ParameterValue = ((SasUiMax - SasUiMin) x pow(UI_VALUE, SasUiStepsPower) + SasUiMin
Der Standardwert ist 1,0f.
SasUiStride
Diese Anmerkung gibt das Inkrement an, das beim Erhöhen oder Dekrementieren dieses Werts verwendet werden soll. Im Gegensatz zu SasUiStepsist SasUiStride beispielsweise bei einem Drehungssteuerelement nützlich, wenn die Daten ungebunden sind und der Benutzer den Parameterwert lieber durch Stride und nicht durch eine vordefinierte Anzahl von Schritten erhöhen möchte. Hostanwendungen sollten den Wert von SasUiStride wie folgt erhöhen (oder je nach Steuerelementverhalten dekrementieren):
ParameterValue = ParameterValue +/- SasUiStride
Der Standardwert ist 1,0f.