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 HD_INSTANCER_H
25 #define HD_INSTANCER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/usd/sdf/path.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class HdSceneDelegate;
35 class HdRenderIndex;
36 class HdRprim;
37 
118 
119 class HdInstancer {
120 public:
122  HD_API
123  HdInstancer(HdSceneDelegate* delegate, SdfPath const& id,
124  SdfPath const &parentInstancerId);
125  virtual ~HdInstancer() {}
126 
128  SdfPath const& GetId() const { return _id; }
129 
131  SdfPath const& GetParentId() const { return _parentId; }
132 
133  HdSceneDelegate* GetDelegate() const { return _delegate; }
134 
135  HD_API
136  static int GetInstancerNumLevels(HdRenderIndex& index,
137  HdRprim const& rprim);
138 
139 private:
140  HdSceneDelegate* _delegate;
141  SdfPath _id;
142  SdfPath _parentId;
143 };
144 
145 
146 PXR_NAMESPACE_CLOSE_SCOPE
147 
148 #endif // HD_INSTANCER_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
SdfPath const & GetId() const
Returns the identifier.
Definition: instancer.h:128
This class exists to facilitate point cloud style instancing.
Definition: instancer.h:119
The render engine state for a given rprim from the scene graph.
Definition: rprim.h:67
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
HD_API HdInstancer(HdSceneDelegate *delegate, SdfPath const &id, SdfPath const &parentInstancerId)
Constructor.
SdfPath const & GetParentId() const
Returns the parent instancer identifier.
Definition: instancer.h:131