All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
collectionsSchema.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_COLLECTIONS_SCHEMA_H
19#define PXR_IMAGING_HD_COLLECTIONS_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
25
26#include "pxr/imaging/hd/schema.h"
27
28// --(BEGIN CUSTOM CODE: Includes)--
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
34// --(END CUSTOM CODE: Declares)--
35
36#define HD_COLLECTIONS_SCHEMA_TOKENS \
37 (collections) \
38
39TF_DECLARE_PUBLIC_TOKENS(HdCollectionsSchemaTokens, HD_API,
40 HD_COLLECTIONS_SCHEMA_TOKENS);
41
42//-----------------------------------------------------------------------------
43
44// The HdCollectionsSchema specifies a wrapper container for collection
45// entries with the key being the collection name.
46//
47
48class HdCollectionsSchema : public HdSchema
49{
50public:
53
54 HdCollectionsSchema(HdContainerDataSourceHandle container)
55 : HdSchema(container) {}
56
62 HD_API
63 static HdCollectionsSchema GetFromParent(
64 const HdContainerDataSourceHandle &fromParentContainer);
65
67
68// --(BEGIN CUSTOM CODE: Schema Methods)--
69// --(END CUSTOM CODE: Schema Methods)--
70
73
74 HD_API
75 TfTokenVector GetCollectionNames() const;
76
77 HD_API
78 HdCollectionSchema GetCollection(const TfToken &name) const;
79
81
84
87 HD_API
88 static const TfToken &GetSchemaToken();
89
92 HD_API
93 static const HdDataSourceLocator &GetDefaultLocator();
94
96
99 HD_API
100 static HdContainerDataSourceHandle
101 BuildRetained(
102 size_t count,
103 const TfToken *names,
104 const HdDataSourceBaseHandle *values);
105
107};
108
109PXR_NAMESPACE_CLOSE_SCOPE
110
111#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
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440