dirtyList.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HD_DIRTY_LIST_H
#define PXR_IMAGING_HD_DIRTY_LIST_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/imaging/hd/repr.h"
#include "pxr/imaging/hd/rprimCollection.h"
#include "pxr/imaging/hd/types.h"

#include <memory>

PXR_NAMESPACE_OPEN_SCOPE

class HdRenderIndex;
class HdChangeTracker;
using HdReprSelectorVector = std::vector<HdReprSelector>;

class HdDirtyList {
public:
    HD_API
    explicit HdDirtyList(HdRenderIndex &index);

    HD_API
    SdfPathVector const& GetDirtyRprims();

    HD_API
    void UpdateRenderTagsAndReprSelectors(
        TfTokenVector const &tags, HdReprSelectorVector const &reprs);

    void PruneToVaryingRprims() {
        _pruneDirtyList = true;
    }

private:
    HdChangeTracker & _GetChangeTracker() const;
    void _UpdateDirtyIdsIfNeeded();

    // Note: Can't use a const ref to the renderIndex because
    // HdRenderIndex::GetRprimIds() isn't a const member fn.
    HdRenderIndex &_renderIndex;
    TfTokenVector _trackedRenderTags;
    HdReprSelectorVector _trackedReprs;
    SdfPathVector _dirtyIds;

    unsigned int _sceneStateVersion;
    unsigned int _rprimIndexVersion;
    unsigned int _rprimRenderTagVersion;
    unsigned int _varyingStateVersion;

    bool _rebuildDirtyList;
    bool _pruneDirtyList;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_IMAGING_HD_DIRTY_LIST_H