apiSchemaAdapter.h
Go to the documentation of this file.
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 //
24 #ifndef PXR_USD_IMAGING_USD_IMAGING_API_SCHEMA_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_API_SCHEMA_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/usdImaging/usdImaging/version.h"
32 
33 #include "pxr/usd/usd/prim.h"
34 
35 #include "pxr/imaging/hd/sceneIndex.h"
36 
37 #include "pxr/base/tf/type.h"
38 
39 #include <memory>
40 
41 
42 PXR_NAMESPACE_OPEN_SCOPE
43 
45 
46 using UsdImagingAPISchemaAdapterSharedPtr =
47  std::shared_ptr<class UsdImagingAPISchemaAdapter>;
48 
56  : public std::enable_shared_from_this<UsdImagingAPISchemaAdapter>
57 {
58 public:
59 
60  USDIMAGING_API
61  virtual ~UsdImagingAPISchemaAdapter();
62 
70  USDIMAGING_API
72  UsdPrim const& prim,
73  TfToken const& appliedInstanceName);
74 
81  USDIMAGING_API
83  UsdPrim const& prim,
84  TfToken const& subprim,
85  TfToken const& appliedInstanceName);
86 
94  USDIMAGING_API
95  virtual HdContainerDataSourceHandle GetImagingSubprimData(
96  UsdPrim const& prim,
97  TfToken const& subprim,
98  TfToken const& appliedInstanceName,
99  const UsdImagingDataSourceStageGlobals &stageGlobals);
100 
104  USDIMAGING_API
106  UsdPrim const& prim,
107  TfToken const& subprim,
108  TfToken const& appliedInstanceName,
109  TfTokenVector const& properties);
110 };
111 
112 
113 class UsdImagingAPISchemaAdapterFactoryBase : public TfType::FactoryBase {
114 public:
115  virtual UsdImagingAPISchemaAdapterSharedPtr New() const = 0;
116 };
117 
118 template <class T>
119 class UsdImagingAPISchemaAdapterFactory
120  : public UsdImagingAPISchemaAdapterFactoryBase {
121 public:
122  virtual UsdImagingAPISchemaAdapterSharedPtr New() const
123  {
124  return std::make_shared<T>();
125  }
126 };
127 
128 PXR_NAMESPACE_CLOSE_SCOPE
129 
130 #endif
Base class for all API schema adapters.
virtual USDIMAGING_API TfToken GetImagingSubprimType(UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName)
Called to determine whether an API schema specifies the hydra type of a given prim previously defined...
Base class of all factory types.
Definition: type.h:73
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
This class is used as a context object with global stage information, that gets passed down to dataso...
virtual USDIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData(UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, const UsdImagingDataSourceStageGlobals &stageGlobals)
Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary pri...
Represents a set of data source locators closed under descendancy.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
virtual USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim(UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, TfTokenVector const &properties)
Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet...
virtual USDIMAGING_API TfTokenVector GetImagingSubprims(UsdPrim const &prim, TfToken const &appliedInstanceName)
Called to determine whether an API schema defines additional child hydra prims beyond the primary hyd...