Loading...
Searching...
No Matches
rileyParamListSchema.h
Go to the documentation of this file.
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 hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_H
36#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_H
37
39
40#include "hdPrman/api.h"
41#include "hdPrman/rileySchemaTypeDefs.h"
42
43#include "pxr/imaging/hd/schema.h"
44#include "pxr/imaging/hd/version.h"
45
46// --(BEGIN CUSTOM CODE: Includes)--
47// --(END CUSTOM CODE: Includes)--
48
49PXR_NAMESPACE_OPEN_SCOPE
50
51// --(BEGIN CUSTOM CODE: Declares)--
52// --(END CUSTOM CODE: Declares)--
53
54#define HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_TOKENS \
55 (params) \
56
57TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyParamListSchemaTokens, HDPRMAN_API,
58 HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_TOKENS);
59
60//-----------------------------------------------------------------------------
61
62// Schema to describe RtParamList.
63//
64// To obtain an RtParamList from this schema, we call the appropriate
65// RtParamList::SetFOO(name, value) for each name in the container params.
66//
67// The schema HdPrmanRileyParamSchema determines what SetFOO method is called
68// with what value. To resolve what SetFOO method to use, the type of the
69// VtValue from the value data source is used as well as the role token if
70// necessary. The value is coming from the value data source.
71//
72
73class HdPrmanRileyParamListSchema : public HdSchema
74{
75public:
78
79 HdPrmanRileyParamListSchema(HdContainerDataSourceHandle container)
80 : HdSchema(container) {}
81
83
84// --(BEGIN CUSTOM CODE: Schema Methods)--
85// --(END CUSTOM CODE: Schema Methods)--
86
89
90 HDPRMAN_API
92#if HD_API_VERSION >= 66
93 const;
94#else
95 ;
96#endif
97
98
100
103
111 HDPRMAN_API
112 static HdContainerDataSourceHandle
113 BuildRetained(
114 const HdContainerDataSourceHandle &params
115 );
116
124 {
125 public:
126 HDPRMAN_API
127 Builder &SetParams(
128 const HdContainerDataSourceHandle &params);
129
131 HDPRMAN_API
132 HdContainerDataSourceHandle Build();
133
134 private:
135 HdContainerDataSourceHandle _params;
136
137 };
138
140};
141
142PXR_NAMESPACE_CLOSE_SCOPE
143
144#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HDPRMAN_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Template class for a schema backed by a container whose children have arbitrary names but an expected...
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:98