All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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//
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
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
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define HD_CATEGORIES_SCHEMA_TOKENS \
36 (categories) \
37
38TF_DECLARE_PUBLIC_TOKENS(HdCategoriesSchemaTokens, HD_API,
39 HD_CATEGORIES_SCHEMA_TOKENS);
40
41//-----------------------------------------------------------------------------
42
43
44class HdCategoriesSchema : public HdSchema
45{
46public:
49
50 HdCategoriesSchema(HdContainerDataSourceHandle container)
51 : HdSchema(container) {}
52
58 HD_API
59 static HdCategoriesSchema GetFromParent(
60 const HdContainerDataSourceHandle &fromParentContainer);
61
63
64// --(BEGIN CUSTOM CODE: Schema Methods)--
65 HD_API
66 VtArray<TfToken> GetIncludedCategoryNames();
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
82
84
87
90 HD_API
91 static const TfToken &GetSchemaToken();
92
95 HD_API
96 static const HdDataSourceLocator &GetDefaultLocator();
97
99
102
104};
105
106PXR_NAMESPACE_CLOSE_SCOPE
107
108#endif
Represents an object that can identify the location of a data source.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Represents an arbitrary dimensional rectangular container class.
Definition: array.h:211
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81