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 terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 ////////////////////////////////////////////////////////////////////////
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_VOLUME_FIELD_BINDING_SCHEMA_H
19 #define PXR_IMAGING_HD_VOLUME_FIELD_BINDING_SCHEMA_H
20 
21 /// \file
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 
31 
32 // --(BEGIN CUSTOM CODE: Declares)--
33 // --(END CUSTOM CODE: Declares)--
34 
35 #define HD_VOLUME_FIELD_BINDING_SCHEMA_TOKENS \
36  (volumeFieldBinding) \
37 
38 TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldBindingSchemaTokens, HD_API,
40 
41 //-----------------------------------------------------------------------------
42 
43 
45 {
46 public:
47  /// \name Schema retrieval
48  /// @{
49 
50  HdVolumeFieldBindingSchema(HdContainerDataSourceHandle container)
51  : HdSchema(container) {}
52 
53  /// Retrieves a container data source with the schema's default name token
54  /// "volumeFieldBinding" from the parent container and constructs a
55  /// HdVolumeFieldBindingSchema instance.
56  /// Because the requested container data source may not exist, the result
57  /// should be checked with IsDefined() or a bool comparison before use.
58  HD_API
60  const HdContainerDataSourceHandle &fromParentContainer);
61 
62  /// @}
63 
64 // --(BEGIN CUSTOM CODE: Schema Methods)--
65 // --(END CUSTOM CODE: Schema Methods)--
66 
67  /// \name Member accessor
68  /// @{
69 
70  HD_API
72 
73  HD_API
75 
76  /// @}
77 
78  /// \name Schema location
79  /// @{
80 
81  /// Returns a token where the container representing this schema is found in
82  /// a container by default.
83  HD_API
84  static const TfToken &GetSchemaToken();
85 
86  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
87  /// where the container representing this schema is found by default.
88  HD_API
89  static const HdDataSourceLocator &GetDefaultLocator();
90 
91  /// @}
92 
93  /// \name Schema construction
94  /// @{
95  HD_API
96  static HdContainerDataSourceHandle
98  size_t count,
99  const TfToken *names,
100  const HdDataSourceBaseHandle *values);
101 
102  /// @}
103 };
104 
106 
107 #endif
#define HD_VOLUME_FIELD_BINDING_SCHEMA_TOKENS
static HD_API const HdDataSourceLocator & GetDefaultLocator()
#define HD_API
Definition: api.h:23
TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldBindingSchemaTokens, HD_API, HD_VOLUME_FIELD_BINDING_SCHEMA_TOKENS)
Definition: token.h:70
HdVolumeFieldBindingSchema(HdContainerDataSourceHandle container)
static HD_API HdContainerDataSourceHandle BuildRetained(size_t count, const TfToken *names, const HdDataSourceBaseHandle *values)
static HD_API const TfToken & GetSchemaToken()
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440
GLuint const GLchar * name
Definition: glcorearb.h:786
HD_API TfTokenVector GetVolumeFieldBindingNames() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1602
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
static HD_API HdVolumeFieldBindingSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
HdPathDataSource::Handle HdPathDataSourceHandle
HD_API HdPathDataSourceHandle GetVolumeFieldBinding(const TfToken &name) const
GLint GLsizei count
Definition: glcorearb.h:405