Loading...
Searching...
No Matches
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
51{
52public:
55
56 HdCollectionsSchema(HdContainerDataSourceHandle container)
57 : HdSchema(container) {}
58
64 HD_API
66 const HdContainerDataSourceHandle &fromParentContainer);
67
69
70// --(BEGIN CUSTOM CODE: Schema Methods)--
71// --(END CUSTOM CODE: Schema Methods)--
72
75
76 HD_API
77 TfTokenVector GetCollectionNames() const;
78
79 HD_API
80 HdCollectionSchema GetCollection(const TfToken &name) const;
81
83
86
89 HD_API
90 static const TfToken &GetSchemaToken();
91
94 HD_API
96
98
101 HD_API
102 static HdContainerDataSourceHandle
103 BuildRetained(
104 size_t count,
105 const TfToken *names,
106 const HdDataSourceBaseHandle *values);
107
109};
110
111PXR_NAMESPACE_CLOSE_SCOPE
112
113#endif
The HdCollectionsSchema specifies a wrapper container for collection entries with the key being the c...
static HD_API HdCollectionsSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "collections" from the parent ...
static HD_API const TfToken & GetSchemaToken()
Returns a token where the container representing this schema is found in a container by default.
static HD_API const HdDataSourceLocator & GetDefaultLocator()
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container represent...
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:92
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440