All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
instancer.h
1 //
2 // Copyright 2019 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 HDPRMAN_INSTANCER_H
25 #define HDPRMAN_INSTANCER_H
26 
27 #include "pxr/pxr.h"
28 #include "hdPrman/context.h"
29 #include "pxr/imaging/hd/instancer.h"
30 #include "pxr/imaging/hd/sceneDelegate.h"
31 #include "pxr/imaging/hd/timeSampleArray.h"
32 #include "pxr/base/tf/hashmap.h"
33 #include "pxr/base/tf/token.h"
34 #include "pxr/base/vt/types.h"
35 #include "pxr/base/vt/value.h"
36 #include <mutex>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 class HdPrmanInstancer : public HdInstancer {
41 public:
42  HdPrmanInstancer(HdSceneDelegate* delegate, SdfPath const& id,
43  SdfPath const &parentInstancerId);
44 
46  ~HdPrmanInstancer();
47 
54  VtMatrix4dArray ComputeInstanceTransforms(SdfPath const &prototypeId);
55 
57  void SampleInstanceTransforms(
58  SdfPath const& prototypeId,
59  VtIntArray const& instanceIndices,
61 
64  void GetInstancePrimvars(
65  SdfPath const& prototypeId,
66  size_t instanceIndex,
67  RixParamList *attrs);
68 
69  // Checks the change tracker to determine whether instance primvars are
70  // dirty, and if so pulls them. Since primvars can only be pulled once,
71  // and are cached, this function is not re-entrant. However, this function
72  // is called by ComputeInstanceTransforms, which is called (potentially)
73  // by HdPrmanMesh::Sync(), which is dispatched in parallel, so it needs
74  // to be guarded by _instanceLock.
75  //
76  // Pulled primvars are cached in _primvarMap.
77  void SyncPrimvars();
78 
79 private:
80 
81  // Mutex guard for SyncPrimvars().
82  std::mutex _instanceLock;
83 
84  // Map of the latest primvar data for this instancer, keyed by primvar name
85  struct _PrimvarValue {
87  VtValue value;
88  };
89  TfHashMap<TfToken,
90  _PrimvarValue,
91  TfToken::HashFunctor> _primvarMap;
92 };
93 
94 
95 PXR_NAMESPACE_CLOSE_SCOPE
96 
97 #endif // HDPRMAN_INSTANCER_H
This class exists to facilitate point cloud style instancing.
Definition: instancer.h:119
Describes a primvar.
Functor to use for hash maps from tokens to other things.
Definition: token.h:168
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Adapter class providing data exchange with the client scene graph.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
An array of a value sampled over time, in struct-of-arrays layout.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182