instancerContext.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_INSTANCER_CONTEXT_H
25 #define PXR_USD_IMAGING_USD_IMAGING_INSTANCER_CONTEXT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/usd/sdf/path.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 using UsdImagingPrimAdapterSharedPtr =
37  std::shared_ptr<class UsdImagingPrimAdapter>;
38 
45 {
46 public:
49 
52 
56 
59 
60  // The inheritable purpose bound to the instance prim being processed. If
61  // the instance prim can provide this, prototypes without an explicit or
62  // inherited purpose will inherit this purpose from the instance.
63  TfToken instanceInheritablePurpose;
64 
67  UsdImagingPrimAdapterSharedPtr instancerAdapter;
68 };
69 
70 
71 PXR_NAMESPACE_CLOSE_SCOPE
72 
73 #endif // PXR_USD_IMAGING_USD_IMAGING_INSTANCER_CONTEXT_H
TfToken childName
The name of the child prim, typically used for prototypes.
SdfPath instancerCachePath
The cachePath of the instancer.
UsdImagingPrimAdapterSharedPtr instancerAdapter
The instancer's prim Adapter.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
SdfPath instancerMaterialUsdPath
The USD path to the material bound to the instance prim being processed.
TfToken instanceDrawMode
The draw mode bound to the instance prim being processed.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...