selectionTracker.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_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();
    virtual ~HdxSelectionTracker();

    HDX_API
    virtual void UpdateSelection(HdRenderIndex *index);

    HDX_API
    virtual bool GetSelectionOffsetBuffer(const HdRenderIndex *index,
                                          bool enableSelection,
                                          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