Aantekening van gebruikersinterface

Gebruik deze aantekening om een effectparameter te koppelen aan een UI-besturingselement in de hostomgeving. Hierdoor kan een gebruiker interactief een effectparameter beheren via de hosttoepassing.

DXSAS definieert een set standaardbesturingselementen in termen van het gegevensmodel en basisgedrag dat auteurs van hosttoepassingen kunnen verwachten. De aantekening van het besturingselement wordt als volgt gebruikt:

string SasUiControl = "ControlType";

waar

ControlType

is een van de volgende:

ControlType Beschrijving Intern gegevenstype Aantekeningen bij besturingselementeigenschappen
Geen Er mag geen besturingselement worden weergegeven. Houd er rekening mee dat een besturingselement zichtbaar is als SasUiVisible Waar is en het type besturingselement een ander type is dan Geen. n.v.t n.v.t
Enig Dit impliceert dat er geen speciale controle wordt aangevraagd. Het weergegeven besturingselement is het resultaat van het door de toepassing gedefinieerde gedrag. n.v.t n.v.t
ColorPicker Vertegenwoordig een kleurwaarde als een kleurstalen. De waarde wordt verpakt in de XYZ-onderdelen van de bijbehorende vector. Het W-onderdeel van de bijbehorende vector is altijd ingesteld op één. floatN waarbij N 1 tot 4 inclusief is. SasUiEnum-
Richting Een richtingsvector. floatN waarbij N 2 tot 4 inclusief is. Geen
FilePicker Een dialoogvenster waarmee de gebruiker door een bestand kan bladeren en selecteren. snaar Geen
ListPicker Een lijst met tekenreekswaarden waaruit de gebruiker één vermelding kan selecteren. De waarden worden gegenereerd op basis van de SasUiEnum aantekening. Een matrix met tekenreeksen, samen met een geheel getal dat de index van de geselecteerde tekenreekswaarde bevat. SasUiEnum-
Numeriek Een set numerieke invoerbesturingselementen (zoals tekstvakken). floatMxN waarbij M en N 1 tot 4 inclusief zijn. SasUiMin, SasUiMax, SasUiStride-
Schuifregelaar Een set schuifregelaars. floatMxN waarbij M en N 1 tot 4 inclusief zijn SasUiMin, SasUiMax, SasUiSteps, SasUiStepsPower
Snaar Een tekstvak voor het bewerken van tekenreeksinhoud. snaar Geen

 

Als het interne gegevenstype niet identiek is aan het type van de bijbehorende parameter, vindt cast-conversie plaats wanneer gegevens worden overgebracht van de parameter van de hosttoepassing naar de effectparameter.

De standaardwaarde is de tekenreeks 'Geen'.

Algemene eigenschappen van de gebruikersinterface

SasUiDescription

Gebruik deze aantekening om een tekenreeks op te geven om een hulpprogramma te beschrijven. Dit kan worden gebruikt voor ui-elementen, zoals knopinfo.

string SasUiDescription = "descriptive string";

Bijvoorbeeld:

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

De standaardwaarde is een lege tekenreeks.

SasUiLabel

Gebruik deze aantekening om een tekenreeks op te geven om een UI-besturingselement te labelen.

string SasUiLabel = "some label;

Hier volgt een voorbeeld:

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

De standaardwaarde is een lege tekenreeks.

SasUiVisible

Gebruik deze aantekening om op te geven of de bijbehorende parameter moet worden weergegeven aan de gebruiker.

bool SasUiVisible = false;

Als deze optie is ingesteld op True, moet de hosttoepassing een UI-besturingselement weergeven voor het bewerken van de parameter met een geannoteerd effect. Als dit onwaar is, wordt er geen gebruikersinterface weergegeven in de hosttoepassing.

Hier volgt een voorbeeld:

float3 UpNormal
<
  string SasUiVisible = false;
>;

De standaardwaarde is Waar.

Eigenschappen van ui-besturingselement

Aantekeningen van besturingseigenschappen zijn aanvullende wijzigingsopties waarmee u kunt bepalen hoe een bepaald besturingselement werkt.

SasUiEnum

Met deze aantekening kunt u het bereik van waarden voor een besturingselement beperken. De aantekening bevat een tekenreeks met waarden die door komma's worden gescheiden.

De standaardwaarde is een lege tekenreeks.

SasUiMax

Met deze aantekening geeft u de maximumwaarde van de bijbehorende parameter op. Deze kan alleen worden gekoppeld aan een numerieke parameter. De maximumwaarde van de parameter wordt daadwerkelijk berekend als:

MaxValue = min(FLT_MAX, PARAMETER_TYPE_MAX);

PARAMETER_TYPE_MAX is de maximumwaarde voor het type dat wordt gebruikt door de bijbehorende parameter. Dit betekent dat de waarde van de parameter, rekening houdend met de SasUiMax-aantekening, wordt berekend als:

ParameterValue = min(NewParameterValue, MaxValue);

De standaardwaarde is FLT_MAX zoals gedefinieerd in Math.h.

SasUiMin

Met deze aantekening wordt de minimumwaarde van de bijbehorende parameter opgegeven. Deze kan alleen worden gekoppeld aan een numerieke parameter. De minimumwaarde van de parameter wordt daadwerkelijk berekend als:

MinValue = max(-FLT_MAX, PARAMETER_TYPE_MIN);

PARAMETER_TYPE_MIN is de minimumwaarde voor het type dat wordt gebruikt door de bijbehorende parameter. Dit betekent dat de waarde van de parameter, rekening houdend met de SasUiMin- aantekening, wordt berekend als:

ParameterValue = max(NewParameterValue, MinValue);

De standaardwaarde is -FLT_MAX zoals gedefinieerd in Math.h.

SasUiSteps

Deze aantekening geeft het aantal stappen op dat kan worden gebruikt bij het verhogen of verlagen van de bijbehorende parameterwaarde. De aantekening is alleen zinvol voor een numeriek getypte parameter. Nul geeft aan dat de hosttoepassing een redelijk aantal stappen kiest.

De standaardwaarde is 0.

SasUiStepsPower

Deze aantekening geeft de exponent aan in de machtsfunctie, die het bereik [0,0f, 1,0f] heeft. Hosttoepassingen moeten de volgende methode implementeren bij het berekenen van parameterwaarden:

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

De standaardwaarde is 1,0f.

SasUiStride

Deze aantekening geeft de verhoging op die moet worden gebruikt bij het verhogen of verlagen van deze waarde. In tegenstelling tot SasUiSteps-, is SasUiStride- handig met een spinnerbesturingselement, bijvoorbeeld, waarbij de gegevens niet afhankelijk zijn en de gebruiker liever de parameterwaarde wilt verhogen op basis van ride in plaats van door een vooraf gedefinieerd aantal stappen. Hosttoepassingen moeten als volgt worden verhoogd (of verlagen, afhankelijk van het gedrag van het besturingselement) door de waarde van SasUiStride:

ParameterValue = ParameterValue +/- SasUiStride

De standaardwaarde is 1,0f.

DirectX Standard-aantekeningen en Semantiekreferenties