Anotação da interface do usuário

Use essa anotação para associar um parâmetro effect a um controle de interface do usuário no ambiente host. Isso permitirá que um usuário controle interativamente um parâmetro de efeito por meio do aplicativo host.

DXSAS define um conjunto de controles padrão em termos de modelo de dados e comportamento básico que os autores de efeito podem esperar de aplicativos host. A anotação de controle é usada assim:

string SasUiControl = "ControlType";

em que

ControlType

é uma das seguintes:

Tipo de controle Descrição Tipo de dados internos Anotações de propriedade de controle
Nenhum Nenhum controle deve ser mostrado. Observe que um controle é visível se SasUiVisible for True e o tipo de controle for qualquer tipo diferente de None. n/a n/a
Qualquer Isto implica que não é solicitado qualquer controlo especial. O controle apresentado é o resultado do comportamento definido pelo aplicativo. n/a n/a
Seletor de cores Representar um valor de cor como uma amostra de cores. O valor é compactado nos componentes XYZ do vetor associado. O componente W do vetor associado é sempre definido como um. flutuarN onde N é de 1 a 4 inclusive. SasUiEnum
Direção Um vetor de direção. flutuarN onde N é 2 a 4 inclusive. Nenhum
Seletor de arquivos Uma caixa de diálogo que permite ao usuário navegar e selecionar um arquivo. string Nenhum
ListPicker Uma lista de valores de cadeia de caracteres a partir da qual o usuário pode selecionar uma entrada. Os valores são gerados a partir da anotação SasUiEnum. Uma matriz de cadeias de caracteres juntamente com um valor inteiro contendo o índice do valor de cadeia de caracteres selecionado. SasUiEnum
Numérico Um conjunto de controles de entrada numérica (como caixas de texto). flutuarMxN onde M e N são 1 a 4 inclusive. SasUiMin, SasUiMax, SasUiStride
Controle deslizante Um conjunto de controles deslizantes. flutuarMxN onde M e N são de 1 a 4 inclusive SasUiMin, SasUiMax, SasUiSteps, SasUiStepsPower
String Uma caixa de texto para editar conteúdo de cadeia de caracteres. string Nenhum

 

Se o tipo de dados interno não for idêntico ao tipo do parâmetro associado, a transmissão ocorrerá quando os dados forem transferidos do parâmetro do aplicativo host para o parâmetro effect.

O padrão é a string "None".

Propriedades comuns da interface do usuário

SasUiDescrição

Use esta anotação para especificar uma cadeia de caracteres para descrever uma ferramenta. Isso pode ser usado para elementos da interface do usuário, como dicas de ferramentas.

string SasUiDescription = "descriptive string";

Por exemplo:

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

O padrão é uma cadeia de caracteres vazia.

SasUiLabel

Use essa anotação para especificar uma cadeia de caracteres para rotular qualquer controle de interface do usuário.

string SasUiLabel = "some label;

Aqui está um exemplo:

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

O padrão é uma cadeia de caracteres vazia.

SasUiVisible

Use esta anotação para especificar se o parâmetro associado deve ser exibido para o usuário.

bool SasUiVisible = false;

Se definido como True, o aplicativo host deve exibir um controle de interface do usuário para editar o parâmetro de efeito anotado. Se false, nenhuma interface do usuário será exibida no aplicativo host.

Aqui está um exemplo:

float3 UpNormal
<
  string SasUiVisible = false;
>;

O padrão é True.

Propriedades de controle da interface do usuário

As anotações de propriedade de controle são modificadores adicionais que ajudam a determinar como um determinado controle opera.

SasUiEnum

Essa anotação permite que você restrinja o intervalo de valores para um controle. A anotação contém uma cadeia de valores delimitada por vírgulas.

O padrão é uma cadeia de caracteres vazia.

SasUiMax

Esta anotação especifica o valor máximo do parâmetro associado. Ele só pode ser associado a um parâmetro digitado numericamente. O valor máximo do parâmetro será realmente calculado como:

MaxValue = min(FLT_MAX, PARAMETER_TYPE_MAX);

PARAMETER_TYPE_MAX é o valor máximo para o tipo usado pelo parâmetro associado. Isso significa que o valor do parâmetro, levando em conta a anotação SasUiMax é calculado como:

ParameterValue = min(NewParameterValue, MaxValue);

O valor padrão é FLT_MAX conforme definido em Math.h.

SasUiMin

Esta anotação especifica o valor mínimo do parâmetro associado. Ele só pode ser associado a qualquer parâmetro digitado numericamente. O valor mínimo do parâmetro será realmente calculado como:

MinValue = max(-FLT_MAX, PARAMETER_TYPE_MIN);

PARAMETER_TYPE_MIN é o valor mínimo para o tipo usado pelo parâmetro associado. Isso significa que o valor do parâmetro, levando em conta a anotação SasUiMin é calculado como:

ParameterValue = max(NewParameterValue, MinValue);

O valor padrão é -FLT_MAX conforme definido em Math.h.

SasUiSteps

Esta anotação especifica o número de etapas que podem ser usadas ao incrementar ou diminuir o valor do parâmetro associado. A anotação só é significativa em um parâmetro digitado numericamente. Zero especifica que o aplicativo host escolherá um número razoável de etapas.

O valor padrão é 0.

SasUiStepsPower

Esta anotação especifica o expoente na função de potência, que tem o intervalo [0,0f, 1,0f]. Os aplicativos host devem implementar o seguinte método ao calcular valores de parâmetro:

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

O valor padrão é 1.0f.

SasUiStride

Esta anotação especifica o incremento que deve ser usado ao incrementar ou diminuir esse valor. Ao contrário SasUiSteps , SasUiStride é útil com um controle rotador, por exemplo, onde os dados são ilimitados e o usuário prefere incrementar o valor do parâmetro por stride em vez de por um número predefinido de etapas. Os aplicativos host devem incrementar (ou diminuir, dependendo do comportamento de controle) pelo valor de SasUiStride da seguinte maneira:

ParameterValue = ParameterValue +/- SasUiStride

O valor padrão é 1.0f.

de referência semântica e anotações padrão do DirectX

 

 

  • Last updated on