Versions Compared

Key

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

...

When none of the above metadata are provided, the parameter name is used directly to define the attribute name.


string label

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.


string niceName

Maya-specific

Specifies the attribute name to use in the user interface, when possible. This will be used in the Maya editors, notably the Node Editor and the Channel Box. It will also be used for the automatically generated Attribute Editor template, unless label is specified.


string options

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:

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


string page

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


float slidermin, float slidermax

int slidermin, int slidermax

Specifies the range of of the slider widget that controls the attribute. This is ignored in Katana.


string type

Specifies the type of the attribute related to this shader parameter. By default, the attribute type is derived from the parameter type and the widget type.

...

Valid for integer shader parameters. The enumeration list should be set using the options metadata.

message

Maya-specific

. Valid for string shader parameters. A message attribute will be created and the connected node's name will be passed as this shader parameter's value.


string label

Specifies the label of the widget that controls the attribute.

string widget

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

checkBox

maya_colorRamp

maya_floatRamp

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.

float slidermin, float slidermax

int slidermin, int slidermax

Specifies the range of of the slider widget that controls the attribute. This is ignored in Katana.

string page

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

string options

A check box widget. Implies a boolean attribute type.

mapper

An option menu with a list of items. 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.


maya_colorRamp

maya_floatRampThis metadata provides extra options. The  enumerand values for  


else if(meta.name == "options")
else if(meta.name == "widget")
{
index = StringMetadata::widget;
}
else if(meta.name == "niceName")
{
index = StringMetadata::niceName;
}
else if(meta.name == "related_to_widget")
{
index = StringMetadata::relatedToWidget;
}
else if(meta.name == "defaultColorSpace")

...