framing.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_CAMERA_UTIL_FRAMING_H
#define PXR_IMAGING_CAMERA_UTIL_FRAMING_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/cameraUtil/api.h"
 
#include "pxr/imaging/cameraUtil/conformWindow.h"
 
#include "pxr/base/gf/rect2i.h"
#include "pxr/base/gf/range2f.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class CameraUtilFraming final
{
public:
    CAMERAUTIL_API
    CameraUtilFraming();
 
    CAMERAUTIL_API
    CameraUtilFraming(
        const GfRange2f &displayWindow,
        const GfRect2i &dataWindow,
        float pixelAspectRatio = 1.0);
 
    CAMERAUTIL_API
    explicit CameraUtilFraming(
        const GfRect2i &dataWindow);
 
    CAMERAUTIL_API
    bool IsValid() const;
 
    CAMERAUTIL_API
    bool operator==(const CameraUtilFraming& other) const;
 
    CAMERAUTIL_API
    bool operator!=(const CameraUtilFraming& other) const;
 
    CAMERAUTIL_API
    GfRange2f ComputeFilmbackWindow(
        float cameraAspectRatio,
        CameraUtilConformWindowPolicy windowPolicy) const;
 
    CAMERAUTIL_API
    GfMatrix4d ApplyToProjectionMatrix(
        const GfMatrix4d &projectionMatrix,
        CameraUtilConformWindowPolicy windowPolicy) const;
 
    GfRange2f displayWindow;
    
    GfRect2i dataWindow;
 
    float pixelAspectRatio;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif