usdRenderSettingsSchema.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_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H


#include "pxr/usdImaging/usdImaging/api.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 USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS \
    (__usdRenderSettings) \
    (resolution) \
    (pixelAspectRatio) \
    (aspectRatioConformPolicy) \
    (dataWindowNDC) \
    (disableMotionBlur) \
    (disableDepthOfField) \
    (camera) \
    (includedPurposes) \
    (materialBindingPurposes) \
    (renderingColorSpace) \
    (products) \
    (namespacedSettings) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderSettingsSchemaTokens, USDIMAGING_API,
    USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS);

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


class UsdImagingUsdRenderSettingsSchema : public HdSchema
{
public:

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

    USDIMAGING_API
    static UsdImagingUsdRenderSettingsSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    USDIMAGING_API
    HdVec2iDataSourceHandle GetResolution() const;

    USDIMAGING_API
    HdFloatDataSourceHandle GetPixelAspectRatio() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;

    USDIMAGING_API
    HdVec4fDataSourceHandle GetDataWindowNDC() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetDisableMotionBlur() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetDisableDepthOfField() const;

    USDIMAGING_API
    HdPathDataSourceHandle GetCamera() const;

    USDIMAGING_API
    HdTokenArrayDataSourceHandle GetIncludedPurposes() const;

    USDIMAGING_API
    HdTokenArrayDataSourceHandle GetMaterialBindingPurposes() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetRenderingColorSpace() const;

    USDIMAGING_API
    HdPathArrayDataSourceHandle GetProducts() const;

    USDIMAGING_API
    HdContainerDataSourceHandle GetNamespacedSettings() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static const HdDataSourceLocator &GetResolutionLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetPixelAspectRatioLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetAspectRatioConformPolicyLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDataWindowNDCLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDisableMotionBlurLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDisableDepthOfFieldLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetCameraLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetIncludedPurposesLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetMaterialBindingPurposesLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetRenderingColorSpaceLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetProductsLocator();

    USDIMAGING_API
    static const HdDataSourceLocator &GetNamespacedSettingsLocator();


    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdVec2iDataSourceHandle &resolution,
        const HdFloatDataSourceHandle &pixelAspectRatio,
        const HdTokenDataSourceHandle &aspectRatioConformPolicy,
        const HdVec4fDataSourceHandle &dataWindowNDC,
        const HdBoolDataSourceHandle &disableMotionBlur,
        const HdBoolDataSourceHandle &disableDepthOfField,
        const HdPathDataSourceHandle &camera,
        const HdTokenArrayDataSourceHandle &includedPurposes,
        const HdTokenArrayDataSourceHandle &materialBindingPurposes,
        const HdTokenDataSourceHandle &renderingColorSpace,
        const HdPathArrayDataSourceHandle &products,
        const HdContainerDataSourceHandle &namespacedSettings
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetResolution(
            const HdVec2iDataSourceHandle &resolution);
        USDIMAGING_API
        Builder &SetPixelAspectRatio(
            const HdFloatDataSourceHandle &pixelAspectRatio);
        USDIMAGING_API
        Builder &SetAspectRatioConformPolicy(
            const HdTokenDataSourceHandle &aspectRatioConformPolicy);
        USDIMAGING_API
        Builder &SetDataWindowNDC(
            const HdVec4fDataSourceHandle &dataWindowNDC);
        USDIMAGING_API
        Builder &SetDisableMotionBlur(
            const HdBoolDataSourceHandle &disableMotionBlur);
        USDIMAGING_API
        Builder &SetDisableDepthOfField(
            const HdBoolDataSourceHandle &disableDepthOfField);
        USDIMAGING_API
        Builder &SetCamera(
            const HdPathDataSourceHandle &camera);
        USDIMAGING_API
        Builder &SetIncludedPurposes(
            const HdTokenArrayDataSourceHandle &includedPurposes);
        USDIMAGING_API
        Builder &SetMaterialBindingPurposes(
            const HdTokenArrayDataSourceHandle &materialBindingPurposes);
        USDIMAGING_API
        Builder &SetRenderingColorSpace(
            const HdTokenDataSourceHandle &renderingColorSpace);
        USDIMAGING_API
        Builder &SetProducts(
            const HdPathArrayDataSourceHandle &products);
        USDIMAGING_API
        Builder &SetNamespacedSettings(
            const HdContainerDataSourceHandle &namespacedSettings);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdVec2iDataSourceHandle _resolution;
        HdFloatDataSourceHandle _pixelAspectRatio;
        HdTokenDataSourceHandle _aspectRatioConformPolicy;
        HdVec4fDataSourceHandle _dataWindowNDC;
        HdBoolDataSourceHandle _disableMotionBlur;
        HdBoolDataSourceHandle _disableDepthOfField;
        HdPathDataSourceHandle _camera;
        HdTokenArrayDataSourceHandle _includedPurposes;
        HdTokenArrayDataSourceHandle _materialBindingPurposes;
        HdTokenDataSourceHandle _renderingColorSpace;
        HdPathArrayDataSourceHandle _products;
        HdContainerDataSourceHandle _namespacedSettings;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif