|
A compact struct to represent a bundle of information about an upstream source attribute. More...
#include <connectableAPI.h>
Public Member Functions | |
UsdShadeConnectionSourceInfo (UsdShadeConnectableAPI const &source_, TfToken const &sourceName_, UsdShadeAttributeType sourceType_, SdfValueTypeName typeName_=SdfValueTypeName()) | |
UsdShadeConnectionSourceInfo (UsdShadeInput const &input) | |
UsdShadeConnectionSourceInfo (UsdShadeOutput const &output) | |
USDSHADE_API | UsdShadeConnectionSourceInfo (UsdStagePtr const &stage, SdfPath const &sourcePath) |
Construct the information for this struct from a property path. | |
bool | IsValid () const |
Return true if this source info is valid for setting up a connection. | |
operator bool () const | |
bool | operator== (UsdShadeConnectionSourceInfo const &other) const |
bool | operator!= (const UsdShadeConnectionSourceInfo &other) const |
Public Attributes | |
UsdShadeConnectableAPI | source |
source is the connectable prim that produces or contains a value for the given shading attribute. | |
TfToken | sourceName |
sourceName is the name of the shading attribute that is the target of the connection. | |
UsdShadeAttributeType | sourceType = UsdShadeAttributeType::Invalid |
sourceType is used to indicate the type of the shading attribute that is the target of the connection. | |
SdfValueTypeName | typeName |
typeName , if specified, is the typename of the attribute to create on the source if it doesn't exist when creating a connection | |
A compact struct to represent a bundle of information about an upstream source attribute.
Definition at line 737 of file connectableAPI.h.
|
inlineexplicit |
Definition at line 755 of file connectableAPI.h.
|
inlineexplicit |
Definition at line 765 of file connectableAPI.h.
|
inlineexplicit |
Definition at line 771 of file connectableAPI.h.
|
explicit |
Construct the information for this struct from a property path.
The source attribute does not have to exist, but the sourcePath
needs to have a valid prefix to identify the sourceType. The source prim needs to exist and be UsdShadeConnectableAPI compatible
|
inline |
Return true if this source info is valid for setting up a connection.
Definition at line 787 of file connectableAPI.h.
|
inlineexplicit |
Definition at line 797 of file connectableAPI.h.
|
inline |
Definition at line 806 of file connectableAPI.h.
|
inline |
Definition at line 800 of file connectableAPI.h.
UsdShadeConnectableAPI source |
source
is the connectable prim that produces or contains a value for the given shading attribute.
Definition at line 740 of file connectableAPI.h.
TfToken sourceName |
sourceName
is the name of the shading attribute that is the target of the connection.
This excludes any namespace prefix that determines the type of the source (eg, output).
Definition at line 744 of file connectableAPI.h.
UsdShadeAttributeType sourceType = UsdShadeAttributeType::Invalid |
sourceType
is used to indicate the type of the shading attribute that is the target of the connection.
The source type is used to determine the namespace prefix that must be attached to sourceName
to determine the source full attribute name.
Definition at line 749 of file connectableAPI.h.
SdfValueTypeName typeName |
typeName
, if specified, is the typename of the attribute to create on the source if it doesn't exist when creating a connection
Definition at line 752 of file connectableAPI.h.