Loading...
Searching...
No Matches
dependencySchema.h
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
25
26/* ************************************************************************** */
27/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdGen/schema.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef PXR_IMAGING_HD_DEPENDENCY_SCHEMA_H
36#define PXR_IMAGING_HD_DEPENDENCY_SCHEMA_H
37
38#include "pxr/imaging/hd/api.h"
39
40#include "pxr/imaging/hd/schema.h"
41
42// --(BEGIN CUSTOM CODE: Includes)--
43// --(END CUSTOM CODE: Includes)--
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47//-----------------------------------------------------------------------------
48
49// --(BEGIN CUSTOM CODE: Declares)--
50// --(END CUSTOM CODE: Declares)--
51
52//-----------------------------------------------------------------------------
53
54#define HD_DEPENDENCY_SCHEMA_TOKENS \
55 (dependedOnPrimPath) \
56 (dependedOnDataSourceLocator) \
57 (affectedDataSourceLocator) \
58
59TF_DECLARE_PUBLIC_TOKENS(HdDependencySchemaTokens, HD_API,
60 HD_DEPENDENCY_SCHEMA_TOKENS);
61
62//-----------------------------------------------------------------------------
63class HdDependencySchema : public HdSchema
64{
65public:
66 HdDependencySchema(HdContainerDataSourceHandle container)
67 : HdSchema(container) {}
68
69// --(BEGIN CUSTOM CODE: Schema Methods)--
70// --(END CUSTOM CODE: Schema Methods)--
71
72 //ACCESSORS
73
74 HD_API
75 HdPathDataSourceHandle GetDependedOnPrimPath();
76 HD_API
77 HdLocatorDataSourceHandle GetDependedOnDataSourceLocator();
78 HD_API
79 HdLocatorDataSourceHandle GetAffectedDataSourceLocator();
80
81 // RETRIEVING AND CONSTRUCTING
82
88 HD_API
89 static HdContainerDataSourceHandle
90 BuildRetained(
91 const HdPathDataSourceHandle &dependedOnPrimPath,
92 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator,
93 const HdLocatorDataSourceHandle &affectedDataSourceLocator
94 );
95
103 {
104 public:
105 HD_API
106 Builder &SetDependedOnPrimPath(
107 const HdPathDataSourceHandle &dependedOnPrimPath);
108 HD_API
109 Builder &SetDependedOnDataSourceLocator(
110 const HdLocatorDataSourceHandle &dependedOnDataSourceLocator);
111 HD_API
112 Builder &SetAffectedDataSourceLocator(
113 const HdLocatorDataSourceHandle &affectedDataSourceLocator);
114
116 HD_API
117 HdContainerDataSourceHandle Build();
118
119 private:
120 HdPathDataSourceHandle _dependedOnPrimPath;
121 HdLocatorDataSourceHandle _dependedOnDataSourceLocator;
122 HdLocatorDataSourceHandle _affectedDataSourceLocator;
123 };
124
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:43
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:108