All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rprimSharedData.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_RPRIM_SHARED_DATA_H
25 #define HD_RPRIM_SHARED_DATA_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/bufferArrayRange.h"
31 #include "pxr/imaging/hd/tokens.h"
32 
33 #include "pxr/usd/sdf/path.h"
34 
35 #include "pxr/base/gf/bbox3d.h"
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
40 // HdRprimSharedData is an assortment of data being shared across HdReprs,
41 // owned by HdRprim. HdDrawItem holds a const pointer to HdRprimSharedData.
42 //
43 // HdRprim
44 // |
45 // +--HdRepr(s)
46 // | |
47 // | +--HdDrawItem(s)-----.
48 // | |
49 // +--HdRprimSharedData <---'
50 //
51 
52 struct HdRprimSharedData {
53  HdRprimSharedData(int barContainerSize)
54  : barContainer(barContainerSize)
55  , bounds()
56  , instancerLevels(-1)
57  , visible(true)
58  , rprimID()
59  , materialTag(HdMaterialTagTokens->defaultMaterialTag)
60  { }
61 
62  HdRprimSharedData(int barContainerSize,
63  bool visible)
64  : barContainer(barContainerSize)
65  , bounds()
66  , instancerLevels(-1)
67  , visible(visible)
68  , rprimID()
69  , materialTag(HdMaterialTagTokens->defaultMaterialTag)
70  { }
71 
72  // BufferArrayRange array
73  HdBufferArrayRangeContainer barContainer;
74 
75  // Used for CPU frustum culling.
76  GfBBox3d bounds;
77 
78  // The number of levels of instancing applied to this rprim.
79  int instancerLevels;
80 
81  // Used for authored/delegate visibility.
82  bool visible;
83 
84  // The owning Rprim's identifier.
85  SdfPath rprimID;
86 
87  // Used to organize drawItems into collections based on material properties.
88  TfToken materialTag;
89 };
90 
91 
92 PXR_NAMESPACE_CLOSE_SCOPE
93 
94 #endif // HD_RPRIM_SHARED_DATA_H
A resizable container of HdBufferArrayRanges.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Basic type: arbitrarily oriented 3D bounding box.
Definition: bbox3d.h:84