Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The supported shader annotations are:


string

...

 niceName

Specifies the string to use for the shader name in the user interface, when possible.

...

Specifies the label of the widget that controls the attribute.


float min, float max

int min, int max

Specifies the minimum and maximum values allowed for the attribute. In Katana, this defines the slider range, as an attribute value cannot be bounded.

...

This metadata provides extra options . The  enumeration list and values for a type set to enum or a widget set to mapper is expected to be defined using this metadata. The expected format is a list of labels, optionally with values, separated by a |. For instance:

...

for specific widget types. See widget for details.


string page

Defines the name of a group under which the widget of the attribute will be placed.

...

Defines the type of widget to control the attribute's value. 

checkBox

A check box widget. Implies a boolean attribute type.

filename

A combination of widgets suitable for a filename. This usually consists of a text field and a file browser button, with some extra features depending of the host software.

mapper

An option menu with a list of items that have an associated numeric value. The list of item labels and values are defined using the options metadata. In Maya, this widget implies an enum attribute, which has an integer value. The  enumeration list and values for a type set to enum or a widget set to mapper is expected to be defined using the options metadata. The expected format is a list of labels, optionally with values, separated by a |. For instance:

Code Block
string options =
			"Euclidean:0|"
			"Manhattan:1|"
			"Chebyshev:2|"
			"Minkowski:3|"

navigation

A combination of widgets suitable to handle a connection from another node.

null

No widget will be created for this attribute.

popup

An option menu. The selected menu item label is set as the attribute value. This widget works for string shader parameters. The menu items are defined by the options metadata as a list of labels separated by |. For instance:

Code Block
string options = "clamp|black|mirror|periodic" 


maya_colorRamp

maya_floatRamp

...