Loading...
Searching...
No Matches
materialBindingsSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef PXR_USD_IMAGING_USD_IMAGING_MATERIAL_BINDINGS_SCHEMA_H
19#define PXR_USD_IMAGING_USD_IMAGING_MATERIAL_BINDINGS_SCHEMA_H
20
22
23#include "pxr/usdImaging/usdImaging/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28#include "pxr/imaging/hd/vectorSchema.h"
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
35 class UsdImagingMaterialBindingSchema>;
36// --(END CUSTOM CODE: Declares)--
37
38#define USD_IMAGING_MATERIAL_BINDINGS_SCHEMA_TOKENS \
39 (usdMaterialBindings) \
40 ((allPurpose, "")) \
41
42TF_DECLARE_PUBLIC_TOKENS(UsdImagingMaterialBindingsSchemaTokens, USDIMAGING_API,
43 USD_IMAGING_MATERIAL_BINDINGS_SCHEMA_TOKENS);
44
45//-----------------------------------------------------------------------------
46
47// The UsdImagingMaterialBindingsSchema specifies a container for all the
48// material bindings declared on a prim. The material binding purpose serves
49// as the key, with the value being a vector of
50// UsdImagingMaterialBindingSchema. While one entry (element) would suffice
51// for a prim's material bindings opinion, we use a vector for aggregating
52// ancestor material bindings to model the inheritance semantics of
53// UsdShadeMaterialBindingAPI.
54//
55
56class UsdImagingMaterialBindingsSchema : public HdSchema
57{
58public:
61
62 UsdImagingMaterialBindingsSchema(HdContainerDataSourceHandle container)
63 : HdSchema(container) {}
64
70 USDIMAGING_API
71 static UsdImagingMaterialBindingsSchema GetFromParent(
72 const HdContainerDataSourceHandle &fromParentContainer);
73
75
76// --(BEGIN CUSTOM CODE: Schema Methods)--
77
80 USDIMAGING_API
81 TfTokenVector GetPurposes() const;
82
84 USDIMAGING_API
85 UsdImagingMaterialBindingVectorSchema GetMaterialBindings() const;
86
88 USDIMAGING_API
90 GetMaterialBindings(const TfToken &purpose) const;
91
92// --(END CUSTOM CODE: Schema Methods)--
93
96
98
101
104 USDIMAGING_API
105 static const TfToken &GetSchemaToken();
106
109 USDIMAGING_API
110 static const HdDataSourceLocator &GetDefaultLocator();
111
113
116
118};
119
120PXR_NAMESPACE_CLOSE_SCOPE
121
122#endif
Represents an object that can identify the location of a data source.
Template class wrapping a vector data source whose children are container data source conforming to a...
Definition: vectorSchema.h:81
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440