camera.h

//
// Copyright 2019 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_CAMERA_H
#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_CAMERA_H
 
#include "hdPrman/api.h"
#include "hdPrman/cameraContext.h"
#include "hdPrman/renderParam.h"
 
#include "pxr/imaging/hd/camera.h"
#include "pxr/imaging/hd/renderDelegate.h"
#include "pxr/imaging/hd/timeSampleArray.h"
#include "pxr/imaging/hd/types.h"
#include "pxr/imaging/hd/version.h"
 
#include "pxr/usd/sdf/path.h"
 
#include "pxr/base/gf/matrix4d.h"
#include "pxr/base/gf/range2d.h"
#include "pxr/base/vt/dictionary.h"
 
#include "pxr/pxr.h"
 
#include <Riley.h>
#include <RileyIds.h>
#include <RiTypesHelper.h>
 
#include <array>
#include <mutex>
#include <optional>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdSceneDelegate;
 
class HdPrmanCamera final : public HdCamera
{
public:
    struct ShutterCurve
    {
        std::optional<float> shutterOpenTime;
        std::optional<float> shutterCloseTime;
        std::optional<std::array<float, 8>> shutteropening;
    };
 
    HDPRMAN_API
    HdPrmanCamera(SdfPath const& id);
 
    HDPRMAN_API
    ~HdPrmanCamera() override;
 
    // ------------------------------------------------------------------------
    // Riley projection shading-node identity
    //
    // Shared with HdPrman_CameraContext, which builds the same kind of
    // projection node for the fallback camera.
    // ------------------------------------------------------------------------
 
    HDPRMAN_API
    static const RtUString& ComputeProjectionShader(
        HdCamera::Projection projection,
        const RtUString& projectionOverride);
 
    static const RtUString& ComputeProjectionShader(
        HdCamera::Projection projection,
        const RtUString&& projectionOverride) = delete;
 
    HDPRMAN_API
    static const RtUString& ProjectionNodeName();
 
    HDPRMAN_API
    void Sync(HdSceneDelegate *sceneDelegate,
              HdRenderParam   *renderParam,
              HdDirtyBits     *dirtyBits) override;
 
    HDPRMAN_API
    void Finalize(HdRenderParam* renderParam) override;
 
    HDPRMAN_API
    riley::CameraId GetRileyCameraId() const;
 
    HDPRMAN_API
    RtUString GetRileyCameraName() const;
 
    HDPRMAN_API
    void UpdateRileyCameraForActive(
        HdPrman_RenderParam* param,
        const HdPrman_CameraContext::ActiveCameraOverlay& overlay);
 
    HDPRMAN_API
    void UpdateRileyCameraForInactive(HdPrman_RenderParam* param);
 
    HDPRMAN_API
    void RecommitRileyCameraForActive(
        HdPrman_RenderParam* param,
        const HdPrman_CameraContext::ActiveCameraOverlay& overlay);
 
    HDPRMAN_API
    HdTimeSampleArray<GfMatrix4d, HDPRMAN_MAX_TIME_SAMPLES> const&
    GetTimeSampleXforms() const {
        return _sampleXforms;
    }
 
    riley::ShadingNode
    GetProjectionNode() const {
        return _projectionNode;
    }
 
#if HD_API_VERSION < 52
    float GetLensDistortionK1() const {
        return _lensDistortionK1;
    }
 
    float GetLensDistortionK2() const {
        return _lensDistortionK2;
    }
 
    const GfVec2f &GetLensDistortionCenter() const {
        return _lensDistortionCenter;
    }
 
    float GetLensDistortionAnaSq() const {
        return _lensDistortionAnaSq;
    }
 
    const GfVec2f &GetLensDistortionAsym() const {
        return _lensDistortionAsym;
    }
 
    float GetLensDistortionScale() const {
        return _lensDistortionScale;
    }
#endif
 
    const ShutterCurve& GetShutterCurve() const {
        return _shutterCurve;
    }
 
    HDPRMAN_API
    void SetRileyCameraParams(RtParamList& camParams,
                              RtParamList& camParamsOverride,
                              RtParamList& projParams) const;
 
    float GetApertureAngle() const {
        return _apertureAngle;
    }
 
    float GetApertureDensity() const {
        return _apertureDensity;
    }
 
    int GetApertureNSides() const {
        return _apertureNSides;
    }
 
    float GetApertureRoundness() const {
        return _apertureRoundness;
    }
 
    float GetDofMult() const {
        return _dofMult;
    }
 
private:
 
    void setFov(RtParamList& projParams) const;
 
    void setScreenWindow(RtParamList& camParams, bool isPerspective) const;
 
    // Commit the camera state to riley. Caller must acquire lock on
    // _rileyCameraMutex.
    void _CommitToRiley(
        riley::Riley* riley,
        const GfRange2d& screenWindow,
        bool disableDepthOfField,
        const RtUString& projectionNameOverride,
        const RtParamList& projectionParamsOverride);
 
    // Commit the clip planes state to riley. Caller must acquire lock on
    // _rileyCameraMutex.
    void _UpdateClipPlanes(riley::Riley* riley);
 
    // Delete the clip planes from riley. Caller must acquire lock on
    // _rileyCameraMutex.
    void _DeleteClipPlanes(riley::Riley* riley);
 
    GfRange2d
    _GetScreenWindow() const;
 
    // This camera's intrinsic screen window, conformed to the framing and
    // window policy carried by the active camera overlay. The camera
    // contributes its aperture; the overlay contributes the framing.
    GfRange2d
    _ConformScreenWindow(
        const HdPrman_CameraContext::ActiveCameraOverlay& overlay) const;
 
    RtParamList
    _ComputeCameraParams(const GfRange2d & screenWindow) const;
 
    RtParamList
    _ComputeNodeParams(
        bool disableDepthOfField,
        const RtUString & projectionOverride) const;
 
    RtParamList
    _ComputePerspectiveNodeParams(bool disableDepthOfField) const;
 
    RtParamList
    _ComputeOrthographicNodeParams() const;
 
    HdTimeSampleArray<GfMatrix4d, HDPRMAN_MAX_TIME_SAMPLES> _sampleXforms;
 
#if HD_API_VERSION < 52
    float _lensDistortionK1;
    float _lensDistortionK2;
    GfVec2f _lensDistortionCenter;
    float _lensDistortionAnaSq;
    GfVec2f _lensDistortionAsym;
    float _lensDistortionScale;
#endif
 
    ShutterCurve _shutterCurve;
 
    float _apertureAngle;
    float _apertureDensity;
    int _apertureNSides;
    float _apertureRoundness;
    float _dofMult;
 
    VtDictionary _params;
 
    riley::ShadingNode _projectionNode;
 
    riley::CameraId _rileyCameraId;
    RtUString _rileyCameraName;
    std::vector<riley::ClippingPlaneId> _rileyClipPlaneIds;
 
    // Mutex for gating access to _rileyCameraId and _rileyCameraName
    mutable std::mutex _rileyCameraMutex;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif  // EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_CAMERA_H