HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
instancerContext.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_IMAGING_USD_IMAGING_INSTANCER_CONTEXT_H
8 #define PXR_USD_IMAGING_USD_IMAGING_INSTANCER_CONTEXT_H
9 
10 /// \file usdImaging/instancerContext.h
11 
12 #include "pxr/pxr.h"
14 #include "pxr/usd/sdf/path.h"
15 
17 
18 
20  std::shared_ptr<class UsdImagingPrimAdapter>;
21 
22 /// \class UsdImagingInstancerContext
23 ///
24 /// Object used by instancer prim adapters to pass along context
25 /// about the instancer and instance prim to prototype prim adapters.
26 ///
28 {
29 public:
30  /// The cachePath of the instancer.
32 
33  /// The name of the child prim, typically used for prototypes.
35 
36  /// The USD path to the material bound to the instance prim
37  /// being processed.
39 
40  /// The draw mode bound to the instance prim being processed.
42 
43  // The inheritable purpose bound to the instance prim being processed. If
44  // the instance prim can provide this, prototypes without an explicit or
45  // inherited purpose will inherit this purpose from the instance.
47 
48  /// The instancer's prim Adapter. Useful when an adapter is needed, but the
49  /// default adapter may be overridden for the sake of instancing.
51 };
52 
53 
55 
56 #endif // PXR_USD_IMAGING_USD_IMAGING_INSTANCER_CONTEXT_H
UsdImagingPrimAdapterSharedPtr instancerAdapter
Definition: token.h:70
Definition: path.h:273
TfToken instanceDrawMode
The draw mode bound to the instance prim being processed.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
TfToken childName
The name of the child prim, typically used for prototypes.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
std::shared_ptr< UsdImagingPrimAdapter > UsdImagingPrimAdapterSharedPtr
SdfPath instancerCachePath
The cachePath of the instancer.