Loading...
Searching...
No Matches
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
48class HdDependencySchema : public HdSchema
49{
50public:
53
54 HdDependencySchema(HdContainerDataSourceHandle container)
55 : HdSchema(container) {}
56
58
59// --(BEGIN CUSTOM CODE: Schema Methods)--
60// --(END CUSTOM CODE: Schema Methods)--
61
64
65 HD_API
66 HdPathDataSourceHandle GetDependedOnPrimPath() const;
67
68 HD_API
69 HdLocatorDataSourceHandle GetDependedOnDataSourceLocator() const;
70
71 HD_API
72 HdLocatorDataSourceHandle GetAffectedDataSourceLocator() const;
73
75
78
86 HD_API
87 static HdContainerDataSourceHandle
88 BuildRetained(
89 const HdPathDataSourceHandle &dependedOnPrimPath,
90 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator,
91 const HdLocatorDataSourceHandle &affectedDataSourceLocator
92 );
93
101 {
102 public:
103 HD_API
104 Builder &SetDependedOnPrimPath(
105 const HdPathDataSourceHandle &dependedOnPrimPath);
106 HD_API
107 Builder &SetDependedOnDataSourceLocator(
108 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator);
109 HD_API
110 Builder &SetAffectedDataSourceLocator(
111 const HdLocatorDataSourceHandle &affectedDataSourceLocator);
112
114 HD_API
115 HdContainerDataSourceHandle Build();
116
117 private:
118 HdPathDataSourceHandle _dependedOnPrimPath;
119 HdLocatorDataSourceHandle _dependedOnDataSourceLocator;
120 HdLocatorDataSourceHandle _affectedDataSourceLocator;
121
122 };
123
125};
126
127PXR_NAMESPACE_CLOSE_SCOPE
128
129#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:92