Adnotacja interfejsu użytkownika

Ta adnotacja umożliwia skojarzenie parametru efektu z kontrolką interfejsu użytkownika w środowisku hosta. Pozwoli to użytkownikowi interaktywnie sterować parametrem efektu za pośrednictwem aplikacji hosta.

DXSAS definiuje zestaw standardowych kontrolek pod względem modelu danych i podstawowego zachowania, które wpływają na autorów mogą oczekiwać od aplikacji hosta. Adnotacja kontrolki jest używana w następujący sposób:

string SasUiControl = "ControlType";

gdzie

ControlType

jest jednym z następujących elementów:

Typ kontrolki	Opis	Wewnętrzny typ danych	Adnotacje właściwości kontrolek
Żaden	Nie należy wyświetlać żadnej kontrolki. Należy pamiętać, że kontrolka jest widoczna, jeśli sasUiVisible ma wartość True, a typ kontrolki jest dowolnym typem innym niż Brak.	N/a	N/a
Jakikolwiek	Oznacza to, że nie jest żądana żadna specjalna kontrola. Przedstawiona kontrolka jest wynikiem zachowania zdefiniowanego przez aplikację.	N/a	N/a
ColorPicker	Reprezentacja wartości koloru jako próbki kolorów. Wartość jest pakowana do składników XYZ skojarzonego wektora. Składnik W skojarzonego wektora jest zawsze ustawiony na jeden.	zmiennoprzecinkoweN, gdzie N wynosi od 1 do 4 włącznie.	SasUiEnum
Kierunek	Wektor kierunku.	floatN gdzie N wynosi od 2 do 4 włącznie.	Żaden
FilePicker	Okno dialogowe umożliwiające użytkownikowi przeglądanie i wybieranie pliku.	struna	Żaden
ListPicker	Lista wartości ciągów, z których użytkownik może wybrać jeden wpis. Wartości są generowane na podstawie adnotacji SasUiEnum.	Tablica ciągów wraz z wartością całkowitą zawierającą indeks wybranej wartości ciągu.	SasUiEnum
Numeryczny	Zestaw liczbowych kontrolek wejściowych (takich jak pola tekstowe).	zmiennoprzecinkoweMxN gdzie M i N mają od 1 do 4 włącznie.	SasUiMin, SasUiMax, SasUiStride
Suwak	Zestaw suwaków.	zmiennoprzecinkoweMxN gdzie M i N są od 1 do 4 włącznie	SasUiMin, SasUiMax, SasUiSteps, SasUiStepsPower
Struna	Pole tekstowe do edytowania zawartości ciągu.	struna	Żaden

 

Jeśli wewnętrzny typ danych nie jest identyczny z typem skojarzonego parametru, rzutowanie nastąpi, gdy dane zostaną przesłane z parametru aplikacji hosta do parametru efektu.

Wartość domyślna to ciąg "None".

Typowe właściwości interfejsu użytkownika

SasUiDescription

Użyj tej adnotacji, aby określić ciąg do opisania narzędzia. Może to być używane w przypadku elementów interfejsu użytkownika, takich jak porady dotyczące narzędzi.

string SasUiDescription = "descriptive string";

Na przykład:

float3 UpNormal
<
  string SasUiDescription = "The normalized up vector";
>;

Wartość domyślna to pusty ciąg.

SasUiLabel

Użyj tej adnotacji, aby określić ciąg, aby oznaczyć dowolną kontrolkę interfejsu użytkownika.

string SasUiLabel = "some label;

Oto przykład:

float3 UpNormal
<
  string SasUiLabel = "Normal that points up.";
>;

Wartość domyślna to pusty ciąg.

SasUiVisible

Użyj tej adnotacji, aby określić, czy skojarzony parametr ma być wyświetlany użytkownikowi.

bool SasUiVisible = false;

Jeśli ustawiono wartość True, aplikacja hosta powinna wyświetlić kontrolkę interfejsu użytkownika do edycji parametru efektu adnotacji. Jeśli wartość false, w aplikacji hosta nie jest wyświetlany żaden interfejs użytkownika.

Oto przykład:

float3 UpNormal
<
  string SasUiVisible = false;
>;

Wartość domyślna to True.

Właściwości kontrolki interfejsu użytkownika

Adnotacje właściwości kontrolek to dodatkowe modyfikatory, które pomagają określić sposób działania określonej kontrolki.

SasUiEnum

Ta adnotacja umożliwia ograniczenie zakresu wartości dla kontrolki. Adnotacja zawiera ciąg wartości rozdzielonych przecinkami.

Wartość domyślna to pusty ciąg.

SasUiMax

Ta adnotacja określa maksymalną wartość skojarzonego parametru. Można go skojarzyć tylko z parametrem typizowanego numerycznie. Maksymalna wartość parametru zostanie obliczona jako:

MaxValue = min(FLT_MAX, PARAMETER_TYPE_MAX);

PARAMETER_TYPE_MAX jest maksymalną wartością typu używanego przez skojarzony parametr. Oznacza to, że wartość parametru, biorąc pod uwagę SasUiMax adnotacja jest obliczana jako:

ParameterValue = min(NewParameterValue, MaxValue);

Wartość domyślna to FLT_MAX zgodnie z definicją w pliku Math.h.

SasUiMin

Ta adnotacja określa minimalną wartość skojarzonego parametru. Można go skojarzyć tylko z dowolnym parametrem typizowanego numerycznie. Minimalna wartość parametru zostanie obliczona jako:

MinValue = max(-FLT_MAX, PARAMETER_TYPE_MIN);

PARAMETER_TYPE_MIN jest minimalną wartością typu używanego przez skojarzony parametr. Oznacza to, że wartość parametru, biorąc pod uwagę SasUiMin adnotacja jest obliczana jako:

ParameterValue = max(NewParameterValue, MinValue);

Wartość domyślna to -FLT_MAX zgodnie z definicją w pliku Math.h.

SasUiSteps

Ta adnotacja określa liczbę kroków, które mogą być używane podczas przyrostowania lub dekrementacji skojarzonej wartości parametru. Adnotacja ma znaczenie tylko dla parametru typizowanego numerycznie. Zero określa, że aplikacja hosta wybierze rozsądną liczbę kroków.

Wartość domyślna to 0.

SasUiStepsPower

Ta adnotacja określa wykładnik w funkcji zasilania, który ma zakres [0.0f, 1.0f]. Aplikacje hosta muszą implementować następującą metodę podczas obliczania wartości parametrów:

ParameterValue = ((SasUiMax - SasUiMin) x pow(UI_VALUE, SasUiStepsPower) + SasUiMin

Wartość domyślna to 1.0f.

SasUiStride

Ta adnotacja określa przyrost, który ma być używany podczas inkrementacji lub dekrementacji tej wartości. W przeciwieństwie do SasUiSteps, SasUiStride przydaje się na przykład za pomocą kontrolki spinner, gdzie dane są niezwiązane, a użytkownik wolałby zwiększać wartość parametru według kroku, a nie przez wstępnie zdefiniowaną liczbę kroków. Aplikacje hosta powinny zwiększać (lub dekrementować w zależności od zachowania kontrolki) przez wartość SasUiStride w następujący sposób:

ParameterValue = ParameterValue +/- SasUiStride

Wartość domyślna to 1.0f.

Tematy pokrewne

adnotacje i semantyka w warstwie DirectX w warstwie Standardowa