HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
categoriesSchema.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_CATEGORIES_SCHEMA_H
19 #define PXR_IMAGING_HD_CATEGORIES_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_CATEGORIES_SCHEMA_TOKENS \
36  (categories) \
37 
38 TF_DECLARE_PUBLIC_TOKENS(HdCategoriesSchemaTokens, HD_API,
40 
41 //-----------------------------------------------------------------------------
42 
43 
45 {
46 public:
47  /// \name Schema retrieval
48  /// @{
49 
50  HdCategoriesSchema(HdContainerDataSourceHandle container)
51  : HdSchema(container) {}
52 
53  /// Retrieves a container data source with the schema's default name token
54  /// "categories" from the parent container and constructs a
55  /// HdCategoriesSchema 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  HD_API
67 
68  HD_API
69  bool IsIncludedInCategory(const TfToken &categoryName);
70 
71  HD_API
72  static HdContainerDataSourceHandle BuildRetained(
73  size_t includedNameCount,
74  const TfToken *includedNames,
75  size_t excludedNameCount,
76  const TfToken *excludedNames);
77 
78 // --(END CUSTOM CODE: Schema Methods)--
79 
80  /// \name Member accessor
81  /// @{
82 
83  /// @}
84 
85  /// \name Schema location
86  /// @{
87 
88  /// Returns a token where the container representing this schema is found in
89  /// a container by default.
90  HD_API
91  static const TfToken &GetSchemaToken();
92 
93  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
94  /// where the container representing this schema is found by default.
95  HD_API
96  static const HdDataSourceLocator &GetDefaultLocator();
97 
98  /// @}
99 
100  /// \name Schema construction
101  /// @{
102 
103  /// @}
104 };
105 
107 
108 #endif
TF_DECLARE_PUBLIC_TOKENS(HdCategoriesSchemaTokens, HD_API, HD_CATEGORIES_SCHEMA_TOKENS)
HdCategoriesSchema(HdContainerDataSourceHandle container)
#define HD_API
Definition: api.h:23
Definition: token.h:70
HD_API bool IsIncludedInCategory(const TfToken &categoryName)
static HD_API const HdDataSourceLocator & GetDefaultLocator()
HD_API VtArray< TfToken > GetIncludedCategoryNames()
static HD_API const TfToken & GetSchemaToken()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
static HD_API HdContainerDataSourceHandle BuildRetained(size_t includedNameCount, const TfToken *includedNames, size_t excludedNameCount, const TfToken *excludedNames)
static HD_API HdCategoriesSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
#define HD_CATEGORIES_SCHEMA_TOKENS