Katana Plug-in APIs 0.1
Public Member Functions

Foundry::Katana::FnOpDescription::InputAttrDescription Class Reference

Description of an Attribute queried as an input through a call to interface.getAttr(). More...

#include <FnOpDescriptionBuilder.h>

Inheritance diagram for Foundry::Katana::FnOpDescription::InputAttrDescription:
Foundry::Katana::FnOpDescription::OptionalAttrDescription Foundry::Katana::FnOpDescription::AttrDescription

List of all members.

Public Member Functions

 InputAttrDescription (AttrTypeDescription type, const std::string &name)
int getInputIndex () const
 Get the input index for the input scene graph that the Attribute will be read from.
std::string getAtLocation () const
 Get the specific location that Attribute will be read from, if any.
void setInputIndex (int inputIndex)
 Set the input index for the input scene graph that the Attribute will be read from.
void setAtLocation (const std::string &atLocation)
 Set a specific location that the Attribute will be read from, if any. This should be used if the Attribute is always read from a specific location (e.g. /root/world), rather than dynamically, based on where the Op is run.

Detailed Description

Description of an Attribute queried as an input through a call to interface.getAttr().

Description of an Attribute used as an input from the scene graph.


Constructor & Destructor Documentation

Foundry::Katana::FnOpDescription::InputAttrDescription::InputAttrDescription ( AttrTypeDescription  type,
const std::string &  name 
) [inline]
Parameters:
typeThe type (AttrTypeDescription) of the Attribute.
nameThe name of the Attribute.

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator