Foundry::Katana::FnOpDescription::OpArgDescription Class Reference

Description of an Attribute used as an opArg. More...

#include <FnOpDescriptionBuilder.h>

Inheritance diagram for Foundry::Katana::FnOpDescription::OpArgDescription:

List of all members.

Public Member Functions
	OpArgDescription (AttrTypeDescription type, const std::string &name)
const std::string &	getWidgetHint () const
	Get the widget hint of the Attribute. The widget hint should correspond to the named values and syntax that is used in Node parameter UIs.
void	setWidgetHint (const std::string &widgetHint)
	Set the widget hint for the Attribute. The widget hint should correspond to the named values and syntax that is used in Node parameter UIs.

---

Detailed Description

Description of an Attribute used as an opArg.

Description of an Attribute used as an opArg, including name, type, whether it's optional or not, and what its widget hint is (if any). The widgetHint should correspond to the widget hint naming/conventions as used in Node parameters UIs.

---

Constructor & Destructor Documentation

Foundry::Katana::FnOpDescription::OpArgDescription::OpArgDescription	(	AttrTypeDescription	type,
		const std::string &	name
	)		[inline]

Parameters:

type	The type (AttrTypeDescription) of the Attribute.
name	The name of the Attribute.

---

The documentation for this class was generated from the following file:

• FnOpDescriptionBuilder.h