All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
instancer.h
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 HDEMBREE_INSTANCER_H
25 #define HDEMBREE_INSTANCER_H
26 
27 #include "pxr/pxr.h"
28 
29 #include "pxr/imaging/hd/instancer.h"
30 #include "pxr/imaging/hd/vtBufferSource.h"
31 
32 #include "pxr/base/tf/hashmap.h"
33 #include "pxr/base/tf/token.h"
34 
35 #include <mutex>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
53 public:
59  HdEmbreeInstancer(HdSceneDelegate* delegate, SdfPath const& id,
60  SdfPath const &parentInstancerId);
61 
64 
71  VtMatrix4dArray ComputeInstanceTransforms(SdfPath const &prototypeId);
72 
73 private:
74  // Checks the change tracker to determine whether instance primvars are
75  // dirty, and if so pulls them. Since primvars can only be pulled once,
76  // and are cached, this function is not re-entrant. However, this function
77  // is called by ComputeInstanceTransforms, which is called (potentially)
78  // by HdEmbreeMesh::Sync(), which is dispatched in parallel, so it needs
79  // to be guarded by _instanceLock.
80  //
81  // Pulled primvars are cached in _primvarMap.
82  void _SyncPrimvars();
83 
84  // Mutex guard for _SyncPrimvars().
85  std::mutex _instanceLock;
86 
87  // Map of the latest primvar data for this instancer, keyed by
88  // primvar name. Primvar values are VtValue, an any-type; they are
89  // interpreted at consumption time (here, in ComputeInstanceTransforms).
90  TfHashMap<TfToken,
92  TfToken::HashFunctor> _primvarMap;
93 };
94 
95 
96 PXR_NAMESPACE_CLOSE_SCOPE
97 
98 #endif // HDEMBREE_INSTANCER_H
VtMatrix4dArray ComputeInstanceTransforms(SdfPath const &prototypeId)
Computes all instance transforms for the provided prototype id, taking into account the scene delegat...
~HdEmbreeInstancer()
Destructor.
HdEmbreeInstancer(HdSceneDelegate *delegate, SdfPath const &id, SdfPath const &parentInstancerId)
Constructor.
This class exists to facilitate point cloud style instancing.
Definition: instancer.h:119
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
HdEmbree implements instancing by adding prototype geometry to the BVH multiple times within HdEmbree...
Definition: instancer.h:52
An implementation of HdBufferSource where the source data value is a VtValue.