All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
dependencySchema.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_IMAGING_HD_DEPENDENCY_SCHEMA_H
19#define PXR_IMAGING_HD_DEPENDENCY_SCHEMA_H
20
22
23#include "pxr/imaging/hd/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 HD_DEPENDENCY_SCHEMA_TOKENS \
36 (dependedOnPrimPath) \
37 (dependedOnDataSourceLocator) \
38 (affectedDataSourceLocator) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdDependencySchemaTokens, HD_API,
41 HD_DEPENDENCY_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45
46class HdDependencySchema : public HdSchema
47{
48public:
51
52 HdDependencySchema(HdContainerDataSourceHandle container)
53 : HdSchema(container) {}
54
56
57// --(BEGIN CUSTOM CODE: Schema Methods)--
58// --(END CUSTOM CODE: Schema Methods)--
59
62
63 HD_API
64 HdPathDataSourceHandle GetDependedOnPrimPath() const;
65
66 HD_API
67 HdLocatorDataSourceHandle GetDependedOnDataSourceLocator() const;
68
69 HD_API
70 HdLocatorDataSourceHandle GetAffectedDataSourceLocator() const;
71
73
76
84 HD_API
85 static HdContainerDataSourceHandle
86 BuildRetained(
87 const HdPathDataSourceHandle &dependedOnPrimPath,
88 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator,
89 const HdLocatorDataSourceHandle &affectedDataSourceLocator
90 );
91
98 class Builder
99 {
100 public:
101 HD_API
102 Builder &SetDependedOnPrimPath(
103 const HdPathDataSourceHandle &dependedOnPrimPath);
104 HD_API
105 Builder &SetDependedOnDataSourceLocator(
106 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator);
107 HD_API
108 Builder &SetAffectedDataSourceLocator(
109 const HdLocatorDataSourceHandle &affectedDataSourceLocator);
110
112 HD_API
113 HdContainerDataSourceHandle Build();
114
115 private:
116 HdPathDataSourceHandle _dependedOnPrimPath;
117 HdLocatorDataSourceHandle _dependedOnDataSourceLocator;
118 HdLocatorDataSourceHandle _affectedDataSourceLocator;
119
120 };
121
123};
124
125PXR_NAMESPACE_CLOSE_SCOPE
126
127#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81