systemSchema.h
1 //
2 // Copyright 2022 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
25 // This file is generated by a script. Do not edit directly. Edit the
26 // schema.template.h file to make changes.
27 
28 #ifndef PXR_IMAGING_HD_SYSTEM_SCHEMA_H
29 #define PXR_IMAGING_HD_SYSTEM_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/schema.h"
34 
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 //-----------------------------------------------------------------------------
40 
41 #define HDSYSTEM_SCHEMA_TOKENS \
42  (system) \
43 
44 TF_DECLARE_PUBLIC_TOKENS(HdSystemSchemaTokens, HD_API,
45  HDSYSTEM_SCHEMA_TOKENS);
46 
47 //-----------------------------------------------------------------------------
48 
50 
56 class HdSystemSchema : public HdSchema
57 {
58 public:
59  HdSystemSchema(HdContainerDataSourceHandle container)
60  : HdSchema(container) {}
61 
62 
68  HD_API
69  static HdDataSourceBaseHandle GetFromPath(
70  HdSceneIndexBaseRefPtr const &inputScene,
71  SdfPath const &fromPath,
72  TfToken const &key,
73  SdfPath *foundAtPath);
74 
83  HD_API
84  static HdContainerDataSourceHandle Compose(
85  HdSceneIndexBaseRefPtr const &inputScene,
86  SdfPath const &fromPath,
87  SdfPath *foundAtPath);
88 
96  HD_API
97  static HdContainerDataSourceHandle ComposeAsPrimDataSource(
98  HdSceneIndexBaseRefPtr const &inputScene,
99  SdfPath const &fromPath,
100  SdfPath *foundAtPath);
101 
107  HD_API
109  const HdContainerDataSourceHandle &fromParentContainer);
110 
113  HD_API
114  static const HdDataSourceLocator &GetDefaultLocator();
115 
116 };
117 
118 PXR_NAMESPACE_CLOSE_SCOPE
119 
120 #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...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
The HdSystemSchema specifies a container that will hold "system" data.
Definition: systemSchema.h:56
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:118
Abstract interface to scene data.
Definition: sceneIndex.h:62
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
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:75
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
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...