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 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 // --(BEGIN CUSTOM CODE: Declares)--
35 // --(END CUSTOM CODE: Declares)--
36 
37 #define HD_SYSTEM_SCHEMA_TOKENS \
38  (system) \
39 
40 TF_DECLARE_PUBLIC_TOKENS(HdSystemSchemaTokens, HD_API,
41  HD_SYSTEM_SCHEMA_TOKENS);
42 
43 //-----------------------------------------------------------------------------
44 
45 
53 class HdSystemSchema : public HdSchema
54 {
55 public:
58 
59  HdSystemSchema(HdContainerDataSourceHandle container)
60  : HdSchema(container) {}
61 
67  HD_API
69  const HdContainerDataSourceHandle &fromParentContainer);
70 
72 
73 // --(BEGIN CUSTOM CODE: Schema Methods)--
74 
80  HD_API
81  static HdDataSourceBaseHandle GetFromPath(
82  HdSceneIndexBaseRefPtr const &inputScene,
83  SdfPath const &fromPath,
84  TfToken const &key,
85  SdfPath *foundAtPath);
86 
95  HD_API
96  static HdContainerDataSourceHandle Compose(
97  HdSceneIndexBaseRefPtr const &inputScene,
98  SdfPath const &fromPath,
99  SdfPath *foundAtPath);
100 
108  HD_API
109  static HdContainerDataSourceHandle ComposeAsPrimDataSource(
110  HdSceneIndexBaseRefPtr const &inputScene,
111  SdfPath const &fromPath,
112  SdfPath *foundAtPath);
113 
114 // --(END CUSTOM CODE: Schema Methods)--
115 
118 
120 
123 
126  HD_API
127  static const TfToken &GetSchemaToken();
128 
131  HD_API
132  static const HdDataSourceLocator &GetDefaultLocator();
133 
135 
138 
140 };
141 
142 PXR_NAMESPACE_CLOSE_SCOPE
143 
144 #endif
static HD_API HdContainerDataSourceHandle ComposeAsPrimDataSource(HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath)
Similar to Compose but this return value would be suitable for using with HdOverlayContainerDataSourc...
Standard pointer typedefs.
static HD_API HdSystemSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "system" from the parent conta...
static HD_API const TfToken & GetSchemaToken()
Returns a token where the container representing this schema is found in a container by default.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
The HdSystemSchema specifies a container that will hold "system" data.
Definition: systemSchema.h:53
Represents an object that can identify the location of a data source.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92
Abstract interface to scene data.
Definition: sceneIndex.h:54
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:280
static HD_API HdDataSourceBaseHandle GetFromPath(HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, TfToken const &key, SdfPath *foundAtPath)
Evaluates the key at fromPath.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:58
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:25
static HD_API const HdDataSourceLocator & GetDefaultLocator()
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container represent...
static HD_API HdContainerDataSourceHandle Compose(HdSceneIndexBaseRefPtr const &inputScene, SdfPath const &fromPath, SdfPath *foundAtPath)
Composes the system container in at fromPath by walking up the prim.dataSources in inputScene and com...