Loading...
Searching...
No Matches
collectionMaterialBindingSchema.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_COLLECTION_MATERIAL_BINDING_SCHEMA_H
19#define PXR_USD_IMAGING_USD_IMAGING_COLLECTION_MATERIAL_BINDING_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// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define USD_IMAGING_COLLECTION_MATERIAL_BINDING_SCHEMA_TOKENS \
36 (collectionMaterialBinding) \
37 (collectionPath) \
38 (materialPath) \
39 (bindingStrength) \
40
41TF_DECLARE_PUBLIC_TOKENS(UsdImagingCollectionMaterialBindingSchemaTokens, USDIMAGING_API,
42 USD_IMAGING_COLLECTION_MATERIAL_BINDING_SCHEMA_TOKENS);
43
44//-----------------------------------------------------------------------------
45
46
47class UsdImagingCollectionMaterialBindingSchema : public HdSchema
48{
49public:
52
53 UsdImagingCollectionMaterialBindingSchema(HdContainerDataSourceHandle container)
54 : HdSchema(container) {}
55
61 USDIMAGING_API
62 static UsdImagingCollectionMaterialBindingSchema GetFromParent(
63 const HdContainerDataSourceHandle &fromParentContainer);
64
66
67// --(BEGIN CUSTOM CODE: Schema Methods)--
68// --(END CUSTOM CODE: Schema Methods)--
69
72
73 USDIMAGING_API
74 HdPathDataSourceHandle GetCollectionPath() const;
75
76 USDIMAGING_API
77 HdPathDataSourceHandle GetMaterialPath() const;
78
79 USDIMAGING_API
80 HdTokenDataSourceHandle GetBindingStrength() const;
81
83
86
89 USDIMAGING_API
90 static const TfToken &GetSchemaToken();
91
94 USDIMAGING_API
95 static const HdDataSourceLocator &GetDefaultLocator();
96
98
101
109 USDIMAGING_API
110 static HdContainerDataSourceHandle
111 BuildRetained(
112 const HdPathDataSourceHandle &collectionPath,
113 const HdPathDataSourceHandle &materialPath,
114 const HdTokenDataSourceHandle &bindingStrength
115 );
116
124 {
125 public:
126 USDIMAGING_API
127 Builder &SetCollectionPath(
128 const HdPathDataSourceHandle &collectionPath);
129 USDIMAGING_API
130 Builder &SetMaterialPath(
131 const HdPathDataSourceHandle &materialPath);
132 USDIMAGING_API
133 Builder &SetBindingStrength(
134 const HdTokenDataSourceHandle &bindingStrength);
135
137 USDIMAGING_API
138 HdContainerDataSourceHandle Build();
139
140 private:
141 HdPathDataSourceHandle _collectionPath;
142 HdPathDataSourceHandle _materialPath;
143 HdTokenDataSourceHandle _bindingStrength;
144
145 };
146
148};
149
150PXR_NAMESPACE_CLOSE_SCOPE
151
152#endif
Represents an object that can identify the location of a data source.
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
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
USDIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81