Loading...
Searching...
No Matches
drawItemInstance.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 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"
29#include "pxr/imaging/hdSt/drawItem.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33using HdSt_DrawBatchSharedPtr = std::shared_ptr<class HdSt_DrawBatch>;
34
48{
49public:
50 HDST_API
51 HdStDrawItemInstance(HdStDrawItem const *drawItem);
52 HDST_API
54
56 HDST_API
57 void SetVisible(bool visible);
58
60 bool IsVisible() const { return _visible; }
61
64 HDST_API
65 void SetBatchIndex(size_t batchIndex);
66
68 size_t GetBatchIndex() const { return _batchIndex; }
69
73 // HDST_API
74 void SetBatch(HdSt_DrawBatch *batch);
75
77 HdStDrawItem const *GetDrawItem() const { return _drawItem; }
78
79private:
81
82 HdSt_DrawBatch * _batch;
83 HdStDrawItem const * _drawItem;
84 size_t _batchIndex;
85 bool _visible;
86};
87
88
89PXR_NAMESPACE_CLOSE_SCOPE
90
91#endif // PXR_IMAGING_HD_ST_DRAW_ITEM_INSTANCE_H
92
A container to store instance state for a drawitem.
HDST_API void SetBatchIndex(size_t batchIndex)
Set index into batch list.
void SetBatch(HdSt_DrawBatch *batch)
Set the batch that will receive the DrawItemInstanceChanged callback when visibility is updated.
HdStDrawItem const * GetDrawItem() const
Return a const pointer to draw item.
size_t GetBatchIndex() const
Query batch index.
HDST_API void SetVisible(bool visible)
Set visibility state.
bool IsVisible() const
Query visibility state.