Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder Class Reference

Helper class for building attributes in Op describe() functions. More...

#include <FnOpDescriptionBuilder.h>

List of all members.

Public Member Functions
void	setSummary (const std::string &summary)
	Sets the short/brief one-line summary of the Op.
void	setHelp (const std::string &help)
	Sets the longer, more detailed help text of the Op.
void	setNumInputs (unsigned int numInputs)
	The number of inputs to the Op.
FnAttribute::GroupAttribute	build ()
	Build and return the result GroupAttribute.
std::vector< std::string >	getOpArgOrder ()
	Get the order that the opArg keys were specified in.
std::vector< std::string >	getInputAttrOrder ()
	Get the order that the input attribute keys were specified in.
std::vector< std::string >	getOutputAttrOrder ()
	Get the order that the output attribute keys were specified in.
void	describeOpArg (const OpArgDescription &opArg)
	Describe an Op arg that the Op may request via getOpArg().
void	describeInputAttr (const InputAttrDescription &inputAttr)
	Describe an Attribute that may be queried via getAttr().
void	describeOutputAttr (const OutputAttrDescription &outputAttr)
	Describe an Attribute that may be set via setAttr().
Static Public Member Functions
static std::vector < FnKatAttributeType >	AttrTypeDescriptionToFnKatAttributeTypes (AttrTypeDescription attrType)
	Converts from AttrTypeDescription types into FnKatAttributeType.

---

Detailed Description

Helper class for building attributes in Op describe() functions.

This class contains helper functionality for building the GroupAttribute that is required as a result of an Op's describe() function.

---

Member Function Documentation

static std::vector<FnKatAttributeType> Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::AttrTypeDescriptionToFnKatAttributeTypes

(

AttrTypeDescription

attrType

)

[inline, static]

Converts from AttrTypeDescription types into FnKatAttributeType.

Returns a vector of FnKatAttributeTypes that the given AttrTypeDescription represents.

void Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::describeInputAttr

(

const InputAttrDescription &

inputAttr

)

[inline]

Describe an Attribute that may be queried via getAttr().

Describe any Attributes that are queried from the scene graph through a call to getAttr() on the Op's interface.

Parameters:

inputAttr

The InputAttrDescription detailing the attribute.

References Foundry::Katana::FnOpDescription::AttrDescription::getName().

void Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::describeOpArg

(

const OpArgDescription &

opArg

)

[inline]

Describe an Op arg that the Op may request via getOpArg().

Describe any opArgs that are requested through getOpArg.

Parameters:

opArg

The OpArgDescription detailing the opArg.

References Foundry::Katana::FnOpDescription::AttrDescription::getName().

void Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::describeOutputAttr

(

const OutputAttrDescription &

outputAttr

)

[inline]

Describe an Attribute that may be set via setAttr().

Describe any Attributes that are set in the scene graph through a call to setAttr() on the Op's interface.

Parameters:

outputAttr

The OutputAttrDescription detailing the attribute.

References Foundry::Katana::FnOpDescription::AttrDescription::getName().

void Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::setHelp

(

const std::string &

help

)

[inline]

Sets the longer, more detailed help text of the Op.

The help text/description should build on the summary, and go into more detail about the Ops functionality.

void Foundry::Katana::FnOpDescription::FnOpDescriptionBuilder::setSummary

(

const std::string &

summary

)

[inline]

Sets the short/brief one-line summary of the Op.

The summary should be a short single sentence describing the Op's function.

---

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

• FnOpDescriptionBuilder.h