Loading...
Searching...
No Matches
schema.h
1//
2// Copyright 2021 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//
24
25#ifndef PXR_IMAGING_HD_SCHEMA_H
26#define PXR_IMAGING_HD_SCHEMA_H
27
28#include "pxr/imaging/hd/api.h"
29
30#include "pxr/imaging/hd/dataSourceTypeDefs.h"
31
32PXR_NAMESPACE_OPEN_SCOPE
33
34// ----------------------------------------------------------------------------
35
43{
44public:
45 HdSchema(HdContainerDataSourceHandle container)
46 : _container(container) {}
47
48
50 HD_API
51 HdContainerDataSourceHandle GetContainer();
52 HD_API
53 bool IsDefined() const;
54
57 explicit operator bool() const { return IsDefined(); }
58
59 using UnderlyingDataSource = HdContainerDataSource;
60
61protected:
62 HdContainerDataSourceHandle _container;
63
68 template <typename T>
69 typename T::Handle _GetTypedDataSource(TfToken name) {
70 return _container ? T::Cast(
71 _container->Get(name)) : nullptr;
72 }
73};
74
75PXR_NAMESPACE_CLOSE_SCOPE
76
77#endif
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition: dataSource.h:116
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
T::Handle _GetTypedDataSource(TfToken name)
Returns a datasource of the requested type for the given name: schema implementations can use this to...
Definition: schema.h:69
HD_API HdContainerDataSourceHandle GetContainer()
Returns the container data source that this schema is interpreting.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88