selectionTracker.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDX_SELECTION_TRACKER_H
#define PXR_IMAGING_HDX_SELECTION_TRACKER_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdx/api.h"
#include "pxr/imaging/hdx/version.h"
#include "pxr/imaging/hd/selection.h"
#include "pxr/base/vt/array.h"
#include <vector>
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class HdRenderIndex;
 
using HdxSelectionTrackerSharedPtr =
    std::shared_ptr<class HdxSelectionTracker>;
 
 
 
class HdxSelectionTracker
{
public:
    HDX_API
    HdxSelectionTracker();
 
    HDX_API
    virtual ~HdxSelectionTracker();
 
    HDX_API
    virtual void UpdateSelection(HdRenderIndex *index);
 
    HDX_API
    virtual bool GetSelectionOffsetBuffer(const HdRenderIndex *index,
                                          bool enableSelectionHighlight,
                                          bool enableLocateHighlight,
                                          VtIntArray *offsets) const;
 
    HDX_API
    virtual VtVec4fArray GetSelectedPointColors(const HdRenderIndex *index);
 
    HDX_API
    int GetVersion() const;
 
    HDX_API
    void SetSelection(HdSelectionSharedPtr const &selection);
 
    HDX_API
    HdSelectionSharedPtr const &GetSelectionMap() const;
 
protected:
    HDX_API
    void _IncrementVersion();
 
private:
    bool _GetSelectionOffsets(HdSelectionSharedPtr const &selection,
                              HdSelection::HighlightMode mode,
                              const HdRenderIndex *index,
                              size_t modeOffset,
                              std::vector<int>* offsets) const;
 
    // A helper class to obtain the union of the selection computed
    // by querying the scene indices (with the HdxSelectionSceneIndexObserver)
    // and the selection set with SetSelection.
    class _MergedSelection;
    std::unique_ptr<_MergedSelection> _mergedSelection;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif //PXR_IMAGING_HDX_SELECTION_TRACKER_H