pickFromRenderBufferTask.h

Go to the documentation of this file.

//
// Copyright 2019 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_PICK_FROM_RENDER_BUFFER_TASK_H
#define PXR_IMAGING_HDX_PICK_FROM_RENDER_BUFFER_TASK_H

#include "pxr/pxr.h"
#include "pxr/imaging/hdx/api.h"
#include "pxr/imaging/hdx/task.h"

#include "pxr/imaging/hd/camera.h"
#include "pxr/imaging/hd/renderBuffer.h"
#include "pxr/imaging/hdx/pickTask.h"

PXR_NAMESPACE_OPEN_SCOPE

/// Pick task params.  This is augmented by HdxPickTaskContextParams, which is
/// passed in on the task context.
struct HdxPickFromRenderBufferTaskParams
{
    HdxPickFromRenderBufferTaskParams()
        : primIdBufferPath()
        , instanceIdBufferPath()
        , elementIdBufferPath()
        , normalBufferPath()
        , depthBufferPath()
        , cameraId()
        , viewport()
    {}

    SdfPath primIdBufferPath;
    SdfPath instanceIdBufferPath;
    SdfPath elementIdBufferPath;
    SdfPath normalBufferPath;
    SdfPath depthBufferPath;

    // The id of the camera used to generate the id buffers.
    SdfPath cameraId;

    // The framing specifying how the camera frustum in mapped into the
    // render buffers.
    CameraUtilFraming framing;
    // Is application overriding the window policy of the camera.
    std::optional<CameraUtilConformWindowPolicy> overrideWindowPolicy;

    // The viewport of the camera used to generate the id buffers.
    // Only used if framing is invalid - for legacy clients.
    GfVec4d viewport;
};

/// \class HdxPickFromRenderBufferTask
///
/// A task for running picking queries against pre-existing id buffers.
/// This task remaps the "pick frustum", provided by HdxPickTaskContextParams,
/// to the camera frustum used to generate the ID buffers.  It then runs the
/// pick query against the subset of the ID buffers contained by the pick
/// frustum.
class HdxPickFromRenderBufferTask : public HdxTask
{
public:
    HDX_API
    HdxPickFromRenderBufferTask(HdSceneDelegate *delegate, SdfPath const& id);

    HDX_API
    ~HdxPickFromRenderBufferTask() override;

    /// Hooks for progressive rendering.
    bool IsConverged() const override;

    /// Prepare the pick task
    HDX_API
    void Prepare(HdTaskContext* ctx,
                 HdRenderIndex* renderIndex) override;

    /// Execute the pick task
    HDX_API
    void Execute(HdTaskContext* ctx) override;

protected:
    /// Sync the render pass resources
    HDX_API
    void _Sync(HdSceneDelegate* delegate,
               HdTaskContext* ctx,
               HdDirtyBits* dirtyBits) override;

private:
    GfMatrix4d _ComputeProjectionMatrix() const;

    HdxPickFromRenderBufferTaskParams _params;
    HdxPickTaskContextParams _contextParams;
    // We need to cache a pointer to the render index so Execute() can
    // map prim ID to paths.
    HdRenderIndex *_index;

    HdRenderBuffer *_primId;
    HdRenderBuffer *_instanceId;
    HdRenderBuffer *_elementId;
    HdRenderBuffer *_normal;
    HdRenderBuffer *_depth;
    const HdCamera *_camera;

    bool _converged;

    HdxPickFromRenderBufferTask() = delete;
    HdxPickFromRenderBufferTask(const HdxPickFromRenderBufferTask &) = delete;
    HdxPickFromRenderBufferTask &operator =(
        const HdxPickFromRenderBufferTask &) = delete;
};

// VtValue requirements
HDX_API
std::ostream& operator<<(std::ostream& out, const HdxPickFromRenderBufferTaskParams& pv);
HDX_API
bool operator==(const HdxPickFromRenderBufferTaskParams& lhs,
                const HdxPickFromRenderBufferTaskParams& rhs);
HDX_API
bool operator!=(const HdxPickFromRenderBufferTaskParams& lhs,
                const HdxPickFromRenderBufferTaskParams& rhs);

PXR_NAMESPACE_CLOSE_SCOPE

#endif //PXR_IMAGING_HDX_PICK_FROM_RENDER_BUFFER_TASK_H