cameraSchema.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
////////////////////////////////////////////////////////////////////////

/* ************************************************************************** */
/* **                                                                      ** */
/* ** This file is generated by a script.                                  ** */
/* **                                                                      ** */
/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
/* ** Edit hdSchemaDefs.py instead to make changes.                        ** */
/* **                                                                      ** */
/* ************************************************************************** */

#ifndef PXR_IMAGING_HD_CAMERA_SCHEMA_H
#define PXR_IMAGING_HD_CAMERA_SCHEMA_H

/// \file

#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/schemaTypeDefs.h"
#include "pxr/imaging/hd/splitDiopterSchema.h"
#include "pxr/imaging/hd/lensDistortionSchema.h"

#include "pxr/imaging/hd/schema.h"

// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--

PXR_NAMESPACE_OPEN_SCOPE

// --(BEGIN CUSTOM CODE: Declares)--
// --(END CUSTOM CODE: Declares)--

#define HD_CAMERA_SCHEMA_TOKENS \
    (camera) \
    (projection) \
    (horizontalAperture) \
    (verticalAperture) \
    (horizontalApertureOffset) \
    (verticalApertureOffset) \
    (focalLength) \
    (clippingRange) \
    (clippingPlanes) \
    (fStop) \
    (focusDistance) \
    (shutterOpen) \
    (shutterClose) \
    (exposure) \
    (exposureTime) \
    (exposureIso) \
    (exposureFStop) \
    (exposureResponsivity) \
    (linearExposureScale) \
    (focusOn) \
    (dofAspect) \
    (splitDiopter) \
    (lensDistortion) \
    (namespacedProperties) \
    (perspective) \
    (orthographic) \

TF_DECLARE_PUBLIC_TOKENS(HdCameraSchemaTokens, HD_API,
    HD_CAMERA_SCHEMA_TOKENS);

//-----------------------------------------------------------------------------


/// \class HdCameraSchema
///
class HdCameraSchema : public HdSchema
{
public:
    /// \name Schema retrieval
    /// @{

    HdCameraSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}

    /// Retrieves a container data source with the schema's default name token
    /// "camera" from the parent container and constructs a
    /// HdCameraSchema instance.
    /// Because the requested container data source may not exist, the result
    /// should be checked with IsDefined() or a bool comparison before use.
    HD_API
    static HdCameraSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);

    /// @}

// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--

    /// \name Member accessor
    /// @{

    HD_API
    HdTokenDataSourceHandle GetProjection() const;

    HD_API
    HdFloatDataSourceHandle GetHorizontalAperture() const;

    HD_API
    HdFloatDataSourceHandle GetVerticalAperture() const;

    HD_API
    HdFloatDataSourceHandle GetHorizontalApertureOffset() const;

    HD_API
    HdFloatDataSourceHandle GetVerticalApertureOffset() const;

    HD_API
    HdFloatDataSourceHandle GetFocalLength() const;

    HD_API
    HdVec2fDataSourceHandle GetClippingRange() const;

    HD_API
    HdVec4dArrayDataSourceHandle GetClippingPlanes() const;

    HD_API
    HdFloatDataSourceHandle GetFStop() const;

    HD_API
    HdFloatDataSourceHandle GetFocusDistance() const;

    HD_API
    HdDoubleDataSourceHandle GetShutterOpen() const;

    HD_API
    HdDoubleDataSourceHandle GetShutterClose() const;

    HD_API
    HdFloatDataSourceHandle GetExposure() const;

    HD_API
    HdFloatDataSourceHandle GetExposureTime() const;

    HD_API
    HdFloatDataSourceHandle GetExposureIso() const;

    HD_API
    HdFloatDataSourceHandle GetExposureFStop() const;

    HD_API
    HdFloatDataSourceHandle GetExposureResponsivity() const;

    HD_API
    HdFloatDataSourceHandle GetLinearExposureScale() const;

    HD_API
    HdBoolDataSourceHandle GetFocusOn() const;

    HD_API
    HdFloatDataSourceHandle GetDofAspect() const;

    HD_API
    HdSplitDiopterSchema GetSplitDiopter() const;

    HD_API
    HdLensDistortionSchema GetLensDistortion() const;

    HD_API
    HdSampledDataSourceContainerContainerSchema GetNamespacedProperties() const; 

    /// @}

    /// \name Schema location
    /// @{

    /// Returns a token where the container representing this schema is found in
    /// a container by default.
    HD_API
    static const TfToken &GetSchemaToken();

    /// Returns an HdDataSourceLocator (relative to the prim-level data source)
    /// where the container representing this schema is found by default.
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();

    /// @}

    /// \name Data source locators for members
    ///
    /// The following methods return an HdDataSourceLocator (relative to the
    /// prim-level data source) where the data source for a member can be found.
    ///
    /// This is often useful for checking intersection against the
    /// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
    /// @{

    /// Prim-level relative data source locator to locate shutterOpen.
    HD_API
    static const HdDataSourceLocator &GetShutterOpenLocator();

    /// Prim-level relative data source locator to locate shutterClose.
    HD_API
    static const HdDataSourceLocator &GetShutterCloseLocator();

    /// Prim-level relative data source locator to locate exposure.
    HD_API
    static const HdDataSourceLocator &GetExposureLocator();

    /// Prim-level relative data source locator to locate exposureTime.
    HD_API
    static const HdDataSourceLocator &GetExposureTimeLocator();

    /// Prim-level relative data source locator to locate exposureIso.
    HD_API
    static const HdDataSourceLocator &GetExposureIsoLocator();

    /// Prim-level relative data source locator to locate exposureFStop.
    HD_API
    static const HdDataSourceLocator &GetExposureFStopLocator();

    /// Prim-level relative data source locator to locate exposureResponsivity.
    HD_API
    static const HdDataSourceLocator &GetExposureResponsivityLocator();

    /// Prim-level relative data source locator to locate linearExposureScale.
    HD_API
    static const HdDataSourceLocator &GetLinearExposureScaleLocator();

    /// Prim-level relative data source locator to locate namespacedProperties.
    HD_API
    static const HdDataSourceLocator &GetNamespacedPropertiesLocator();
    /// @} 

    /// \name Schema construction
    /// @{

    /// \deprecated Use Builder instead.
    ///
    /// Builds a container data source which includes the provided child data
    /// sources. Parameters with nullptr values are excluded. This is a
    /// low-level interface. For cases in which it's desired to define
    /// the container with a sparse set of child fields, the Builder class
    /// is often more convenient and readable.
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdTokenDataSourceHandle &projection,
        const HdFloatDataSourceHandle &horizontalAperture,
        const HdFloatDataSourceHandle &verticalAperture,
        const HdFloatDataSourceHandle &horizontalApertureOffset,
        const HdFloatDataSourceHandle &verticalApertureOffset,
        const HdFloatDataSourceHandle &focalLength,
        const HdVec2fDataSourceHandle &clippingRange,
        const HdVec4dArrayDataSourceHandle &clippingPlanes,
        const HdFloatDataSourceHandle &fStop,
        const HdFloatDataSourceHandle &focusDistance,
        const HdDoubleDataSourceHandle &shutterOpen,
        const HdDoubleDataSourceHandle &shutterClose,
        const HdFloatDataSourceHandle &exposure,
        const HdFloatDataSourceHandle &exposureTime,
        const HdFloatDataSourceHandle &exposureIso,
        const HdFloatDataSourceHandle &exposureFStop,
        const HdFloatDataSourceHandle &exposureResponsivity,
        const HdFloatDataSourceHandle &linearExposureScale,
        const HdBoolDataSourceHandle &focusOn,
        const HdFloatDataSourceHandle &dofAspect,
        const HdContainerDataSourceHandle &splitDiopter,
        const HdContainerDataSourceHandle &lensDistortion,
        const HdContainerDataSourceHandle &namespacedProperties
    );

    /// \class HdCameraSchema::Builder
    /// 
    /// Utility class for setting sparse sets of child data source fields to be
    /// filled as arguments into BuildRetained. Because all setter methods
    /// return a reference to the instance, this can be used in the "builder
    /// pattern" form.
    class Builder
    {
    public:
        HD_API
        Builder &SetProjection(
            const HdTokenDataSourceHandle &projection);
        HD_API
        Builder &SetHorizontalAperture(
            const HdFloatDataSourceHandle &horizontalAperture);
        HD_API
        Builder &SetVerticalAperture(
            const HdFloatDataSourceHandle &verticalAperture);
        HD_API
        Builder &SetHorizontalApertureOffset(
            const HdFloatDataSourceHandle &horizontalApertureOffset);
        HD_API
        Builder &SetVerticalApertureOffset(
            const HdFloatDataSourceHandle &verticalApertureOffset);
        HD_API
        Builder &SetFocalLength(
            const HdFloatDataSourceHandle &focalLength);
        HD_API
        Builder &SetClippingRange(
            const HdVec2fDataSourceHandle &clippingRange);
        HD_API
        Builder &SetClippingPlanes(
            const HdVec4dArrayDataSourceHandle &clippingPlanes);
        HD_API
        Builder &SetFStop(
            const HdFloatDataSourceHandle &fStop);
        HD_API
        Builder &SetFocusDistance(
            const HdFloatDataSourceHandle &focusDistance);
        HD_API
        Builder &SetShutterOpen(
            const HdDoubleDataSourceHandle &shutterOpen);
        HD_API
        Builder &SetShutterClose(
            const HdDoubleDataSourceHandle &shutterClose);
        HD_API
        Builder &SetExposure(
            const HdFloatDataSourceHandle &exposure);
        HD_API
        Builder &SetExposureTime(
            const HdFloatDataSourceHandle &exposureTime);
        HD_API
        Builder &SetExposureIso(
            const HdFloatDataSourceHandle &exposureIso);
        HD_API
        Builder &SetExposureFStop(
            const HdFloatDataSourceHandle &exposureFStop);
        HD_API
        Builder &SetExposureResponsivity(
            const HdFloatDataSourceHandle &exposureResponsivity);
        HD_API
        Builder &SetLinearExposureScale(
            const HdFloatDataSourceHandle &linearExposureScale);
        HD_API
        Builder &SetFocusOn(
            const HdBoolDataSourceHandle &focusOn);
        HD_API
        Builder &SetDofAspect(
            const HdFloatDataSourceHandle &dofAspect);
        HD_API
        Builder &SetSplitDiopter(
            const HdContainerDataSourceHandle &splitDiopter);
        HD_API
        Builder &SetLensDistortion(
            const HdContainerDataSourceHandle &lensDistortion);
        HD_API
        Builder &SetNamespacedProperties(
            const HdContainerDataSourceHandle &namespacedProperties);

        /// Returns a container data source containing the members set thus far.
        HD_API
        HdContainerDataSourceHandle Build();

    private:
        HdTokenDataSourceHandle _projection;
        HdFloatDataSourceHandle _horizontalAperture;
        HdFloatDataSourceHandle _verticalAperture;
        HdFloatDataSourceHandle _horizontalApertureOffset;
        HdFloatDataSourceHandle _verticalApertureOffset;
        HdFloatDataSourceHandle _focalLength;
        HdVec2fDataSourceHandle _clippingRange;
        HdVec4dArrayDataSourceHandle _clippingPlanes;
        HdFloatDataSourceHandle _fStop;
        HdFloatDataSourceHandle _focusDistance;
        HdDoubleDataSourceHandle _shutterOpen;
        HdDoubleDataSourceHandle _shutterClose;
        HdFloatDataSourceHandle _exposure;
        HdFloatDataSourceHandle _exposureTime;
        HdFloatDataSourceHandle _exposureIso;
        HdFloatDataSourceHandle _exposureFStop;
        HdFloatDataSourceHandle _exposureResponsivity;
        HdFloatDataSourceHandle _linearExposureScale;
        HdBoolDataSourceHandle _focusOn;
        HdFloatDataSourceHandle _dofAspect;
        HdContainerDataSourceHandle _splitDiopter;
        HdContainerDataSourceHandle _lensDistortion;
        HdContainerDataSourceHandle _namespacedProperties;

    };

    /// Returns token data source for use as projection value.
    ///
    /// The following values will be stored statically and reused for future
    /// calls:
    /// - HdCameraSchemaTokens->perspective
    /// - HdCameraSchemaTokens->orthographic
    HD_API
    static HdTokenDataSourceHandle BuildProjectionDataSource(
        const TfToken &projection);

    /// @}
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif