HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
drawItemInstance.h
Go to the documentation of this file.
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 PXR_IMAGING_HD_ST_DRAW_ITEM_INSTANCE_H
25 #define PXR_IMAGING_HD_ST_DRAW_ITEM_INSTANCE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
30 
32 
33 using HdSt_DrawBatchSharedPtr = std::shared_ptr<class HdSt_DrawBatch>;
34 
35 /// \class HdStDrawItemInstance
36 ///
37 /// A container to store instance state for a drawitem.
38 ///
39 /// During culling, the visibility state will be set. If the instance
40 /// has a batch, the batch will get a DrawItemInstanceChanged
41 /// callback.
42 ///
43 /// The Batch is responsible for calling SetBatch and SetBatchIndex
44 /// when adding / appending the instance. If the batch does not require
45 /// the DrawItemInstanceChanged callback, then this step can be skipped
46 ///
48 {
49 public:
50  HDST_API
51  HdStDrawItemInstance(HdStDrawItem const *drawItem);
52  HDST_API
54 
55  /// Set visibility state
56  HDST_API
57  void SetVisible(bool visible);
58 
59  /// Query visibility state
60  bool IsVisible() const { return _visible; }
61 
62  /// Set index into batch list. Can be used by
63  /// batch during DrawItemInstanceChanged callback
64  HDST_API
65  void SetBatchIndex(size_t batchIndex);
66 
67  /// Query batch index
68  size_t GetBatchIndex() const { return _batchIndex; }
69 
70  /// Set the batch that will receive the DrawItemInstanceChanged
71  /// callback when visibility is updated. Setting batch to NULL
72  /// will disable this callback.
73  // HDST_API
74  void SetBatch(HdSt_DrawBatch *batch);
75 
76  /// Return a const pointer to draw item
77  HdStDrawItem const *GetDrawItem() const { return _drawItem; }
78 
79 private:
80  HdStDrawItemInstance();
81 
82  HdSt_DrawBatch * _batch;
83  HdStDrawItem const * _drawItem;
84  size_t _batchIndex;
85  bool _visible;
86 };
87 
88 
90 
91 #endif // PXR_IMAGING_HD_ST_DRAW_ITEM_INSTANCE_H
92 
HDST_API void SetVisible(bool visible)
Set visibility state.
void SetBatch(HdSt_DrawBatch *batch)
bool IsVisible() const
Query visibility state.
HDST_API ~HdStDrawItemInstance()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
size_t GetBatchIndex() const
Query batch index.
HDST_API void SetBatchIndex(size_t batchIndex)
HdStDrawItem const * GetDrawItem() const
Return a const pointer to draw item.
std::shared_ptr< class HdSt_DrawBatch > HdSt_DrawBatchSharedPtr
Definition: commandBuffer.h:49