All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
systemSchema.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_SYSTEM_SCHEMA_H
19#define PXR_IMAGING_HD_SYSTEM_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)--
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
35// --(END CUSTOM CODE: Declares)--
36
37#define HD_SYSTEM_SCHEMA_TOKENS \
38 (system) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdSystemSchemaTokens, HD_API,
41 HD_SYSTEM_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45// The HdSystemSchema specifies a container that will hold "system" data. Each
46// piece of system data is identified by a key within the container. A piece
47// of system data is evaluated at a given location by walking up the namespace
48// looking for a system container that contains the corresponding key.
49//
50
51class HdSystemSchema : public HdSchema
52{
53public:
56
57 HdSystemSchema(HdContainerDataSourceHandle container)
58 : HdSchema(container) {}
59
65 HD_API
66 static HdSystemSchema GetFromParent(
67 const HdContainerDataSourceHandle &fromParentContainer);
68
70
71// --(BEGIN CUSTOM CODE: Schema Methods)--
72
78 HD_API
79 static HdDataSourceBaseHandle GetFromPath(
80 HdSceneIndexBaseRefPtr const &inputScene,
81 SdfPath const &fromPath,
82 TfToken const &key,
83 SdfPath *foundAtPath);
84
93 HD_API
94 static HdContainerDataSourceHandle Compose(
95 HdSceneIndexBaseRefPtr const &inputScene,
96 SdfPath const &fromPath,
97 SdfPath *foundAtPath);
98
106 HD_API
107 static HdContainerDataSourceHandle ComposeAsPrimDataSource(
108 HdSceneIndexBaseRefPtr const &inputScene,
109 SdfPath const &fromPath,
110 SdfPath *foundAtPath);
111
112// --(END CUSTOM CODE: Schema Methods)--
113
116
118
121
124 HD_API
125 static const TfToken &GetSchemaToken();
126
129 HD_API
130 static const HdDataSourceLocator &GetDefaultLocator();
131
133
136
138};
139
140PXR_NAMESPACE_CLOSE_SCOPE
141
142#endif
Represents an object that can identify the location of a data source.
Abstract interface to scene data.
Definition: sceneIndex.h:48
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Standard pointer typedefs.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:58
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81