HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
volumeFieldBindingSchema.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 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 /* ************************************************************************** */
27 /* ** This file is generated by a script. Do not edit directly. Edit ** */
28 /* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29 /* ************************************************************************** */
30 
31 #ifndef PXR_IMAGING_HD_VOLUME_FIELD_BINDING_SCHEMA_H
32 #define PXR_IMAGING_HD_VOLUME_FIELD_BINDING_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDVOLUMEFIELDBINDING_SCHEMA_TOKENS \
43  (volumeFieldBinding) \
44 
45 TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldBindingSchemaTokens, HD_API,
47 
48 //-----------------------------------------------------------------------------
49 
51 {
52 public:
53  HdVolumeFieldBindingSchema(HdContainerDataSourceHandle container)
54  : HdSchema(container) {}
55 
56  HD_API
57  static HdContainerDataSourceHandle
59  size_t count,
60  TfToken *names,
61  HdDataSourceBaseHandle *values);
62 
63  HD_API
65 
66  HD_API
68 
69 
70  /// Retrieves a container data source with the schema's default name token
71  /// "volumeFieldBinding" from the parent container and constructs a
72  /// HdVolumeFieldBindingSchema instance.
73  /// Because the requested container data source may not exist, the result
74  /// should be checked with IsDefined() or a bool comparison before use.
75  HD_API
77  const HdContainerDataSourceHandle &fromParentContainer);
78 
79  /// Returns a token where the container representing this schema is found in
80  /// a container by default.
81  HD_API
82  static const TfToken &GetSchemaToken();
83 
84  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
85  /// where the container representing this schema is found by default.
86  HD_API
87  static const HdDataSourceLocator &GetDefaultLocator();
88 
89 };
90 
92 
93 #endif
HD_API TfTokenVector GetVolumeFieldBindingNames()
static HD_API const HdDataSourceLocator & GetDefaultLocator()
#define HD_API
Definition: api.h:40
HD_API HdPathDataSourceHandle GetVolumeFieldBinding(TfToken const &name)
static HD_API HdContainerDataSourceHandle BuildRetained(size_t count, TfToken *names, HdDataSourceBaseHandle *values)
Definition: token.h:87
HdVolumeFieldBindingSchema(HdContainerDataSourceHandle container)
static HD_API const TfToken & GetSchemaToken()
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldBindingSchemaTokens, HD_API, HDVOLUMEFIELDBINDING_SCHEMA_TOKENS)
GLuint const GLchar * name
Definition: glcorearb.h:786
#define HDVOLUMEFIELDBINDING_SCHEMA_TOKENS
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1602
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API HdVolumeFieldBindingSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
HdPathDataSource::Handle HdPathDataSourceHandle
GLint GLsizei count
Definition: glcorearb.h:405