usdrt::UsdShadeInput

class UsdShadeInput

This class encapsulates a shader or node-graph input, which is a connectable attribute representing a typed value.

Public Functions

UsdShadeInput() = default: Default constructor returns an invalid Input. Exists for the sake of container classes.

inline TfToken GetFullName() const: Get the name of the attribute associated with the Input.

inline TfToken GetBaseName() const

Returns the name of the input.

We call this the base name since it strips off the “inputs:” namespace prefix from the attribute name, and returns it.

inline SdfValueTypeName GetTypeName() const: Get the “scene description” value type name of the attribute associated with the Input.

inline explicit UsdShadeInput(const UsdAttribute &attr): Speculative constructor that will produce a valid UsdShadeInput when attr already represents a shade Input, and produces an invalid UsdShadeInput otherwise (i.e. the explicit bool conversion operator will return false).

template<typename T> inline bool Get(T *value, UsdTimeCode time = UsdTimeCode::Default()) const: Convenience wrapper for the templated UsdAttribute::Get().

template<typename T> inline bool Set(const T &value, UsdTimeCode time = UsdTimeCode::Default()): This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set a value of the Input at time.

inline const UsdAttribute &GetAttr() const: Explicit UsdAttribute extractor.

inline operator const UsdAttribute&() const: Allow UsdShadeInput to auto-convert to UsdAttribute, so you can pass a UsdShadeInput to any function that accepts a UsdAttribute or const-ref thereto.

inline bool IsDefined() const: Return true if the wrapped UsdAttribute is defined, and in addition the attribute is identified as an input.

inline explicit operator bool() const: Return true if this Input is valid for querying and authoring values and metadata, which is identically equivalent to IsDefined().

inline bool ConnectToSource(const UsdShadeInput &sourceInput) const

Connects this Input to the given input, sourceInput.