usdrt::UsdShadeNodeGraph
Defined in usdrt/scenegraph/usd/usdShade/nodeGraph.h
Functions
usdrt::UsdShadeNodeGraph::Define: Attempt to ensure a UsdPrim adhering to this schema at
path
is defined (according to UsdPrim::IsDefined()) on this stage.usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdShadeNodeGraph::UsdShadeNodeGraph: Construct a UsdShadeNodeGraph on UsdPrim
prim
. Equivalent to UsdShadeNodeGraph::Get(prim.GetStage(), prim.GetPath()) for a validprim
, but will not immediately throw an error for an invalidprim
.usdrt::UsdShadeNodeGraph::UsdShadeNodeGraph: Construct a UsdShadeNodeGraph on the prim held by
schemaObj
. Should be preferred over UsdShadeNodeGraph (schemaObj.GetPrim()), as it preserves SchemaBase state.usdrt::UsdShadeNodeGraph::operator bool: Boolean operator.
usdrt::UsdShadeNodeGraph::~UsdShadeNodeGraph: Destructor.
Variables
usdrt::UsdShadeNodeGraph::schemaType: Compile time constant representing what kind of schema this class is.
-
class UsdShadeNodeGraph : public usdrt::UsdTyped
A node-graph is a container for shading nodes, as well as other node-graphs. It has a public input interface and provides a list of public outputs.
Node Graph Interfaces
One of the most important functions of a node-graph is to host the “interface” with which clients of already-built shading networks will interact. Please see Interface Inputs for a detailed explanation of what the interface provides, and how to construct and use it, to effectively share/instance shader networks.
Node Graph Outputs
These behave like outputs on a shader and are typically connected to an output on a shader inside the node-graph.
Subclassed by usdrt::UsdShadeMaterial
Public Functions
-
inline explicit UsdShadeNodeGraph(const UsdPrim &prim = UsdPrim())
Construct a UsdShadeNodeGraph on UsdPrim
prim
. Equivalent to UsdShadeNodeGraph::Get(prim.GetStage(), prim.GetPath()) for a validprim
, but will not immediately throw an error for an invalidprim
.
-
inline explicit UsdShadeNodeGraph(const UsdSchemaBase &schemaObj)
Construct a UsdShadeNodeGraph on the prim held by
schemaObj
. Should be preferred over UsdShadeNodeGraph(schemaObj.GetPrim()), as it preserves SchemaBase state.
-
inline virtual ~UsdShadeNodeGraph()
Destructor.
-
inline operator bool() const
Boolean operator.
- Returns
Return true if the contained prim is an instance of this schema using
IsA
, and false otherwise.
Public Static Functions
-
static inline UsdShadeNodeGraph Define(const UsdStageRefPtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at
path
is defined (according to UsdPrim::IsDefined()) on this stage.
Public Static Attributes
-
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
Compile time constant representing what kind of schema this class is.
See also
UsdSchemaType
-
inline explicit UsdShadeNodeGraph(const UsdPrim &prim = UsdPrim())