renderProductSchema.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_RENDER_PRODUCT_SCHEMA_H
#define PXR_IMAGING_HD_RENDER_PRODUCT_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/schemaTypeDefs.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--
 
// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
// --(END CUSTOM CODE: Declares)--
 
#define HD_RENDER_PRODUCT_SCHEMA_TOKENS \
    (renderProduct) \
    (path) \
    (type) \
    (name) \
    (resolution) \
    (renderVars) \
    (cameraPrim) \
    (pixelAspectRatio) \
    (aspectRatioConformPolicy) \
    (apertureSize) \
    (dataWindowNDC) \
    (disableMotionBlur) \
    (disableDepthOfField) \
    (namespacedSettings) \
 
TF_DECLARE_PUBLIC_TOKENS(HdRenderProductSchemaTokens, HD_API,
    HD_RENDER_PRODUCT_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
 
class HdRenderProductSchema : public HdSchema
{
public:
 
    HdRenderProductSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdRenderProductSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdPathDataSourceHandle GetPath() const;
 
    HD_API
    HdTokenDataSourceHandle GetType() const;
 
    HD_API
    HdTokenDataSourceHandle GetName() const;
 
    HD_API
    HdVec2iDataSourceHandle GetResolution() const;
 
    HD_API
    HdRenderVarVectorSchema GetRenderVars() const;
 
    HD_API
    HdPathDataSourceHandle GetCameraPrim() const;
 
    HD_API
    HdFloatDataSourceHandle GetPixelAspectRatio() const;
 
    HD_API
    HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;
 
    HD_API
    HdVec2fDataSourceHandle GetApertureSize() const;
 
    HD_API
    HdVec4fDataSourceHandle GetDataWindowNDC() const;
 
    HD_API
    HdBoolDataSourceHandle GetDisableMotionBlur() const;
 
    HD_API
    HdBoolDataSourceHandle GetDisableDepthOfField() const;
 
    HD_API
    HdContainerDataSourceHandle GetNamespacedSettings() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static const HdDataSourceLocator &GetResolutionLocator();
 
    HD_API
    static const HdDataSourceLocator &GetRenderVarsLocator();
 
    HD_API
    static const HdDataSourceLocator &GetNamespacedSettingsLocator();
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &path,
        const HdTokenDataSourceHandle &type,
        const HdTokenDataSourceHandle &name,
        const HdVec2iDataSourceHandle &resolution,
        const HdVectorDataSourceHandle &renderVars,
        const HdPathDataSourceHandle &cameraPrim,
        const HdFloatDataSourceHandle &pixelAspectRatio,
        const HdTokenDataSourceHandle &aspectRatioConformPolicy,
        const HdVec2fDataSourceHandle &apertureSize,
        const HdVec4fDataSourceHandle &dataWindowNDC,
        const HdBoolDataSourceHandle &disableMotionBlur,
        const HdBoolDataSourceHandle &disableDepthOfField,
        const HdContainerDataSourceHandle &namespacedSettings
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetPath(
            const HdPathDataSourceHandle &path);
        HD_API
        Builder &SetType(
            const HdTokenDataSourceHandle &type);
        HD_API
        Builder &SetName(
            const HdTokenDataSourceHandle &name);
        HD_API
        Builder &SetResolution(
            const HdVec2iDataSourceHandle &resolution);
        HD_API
        Builder &SetRenderVars(
            const HdVectorDataSourceHandle &renderVars);
        HD_API
        Builder &SetCameraPrim(
            const HdPathDataSourceHandle &cameraPrim);
        HD_API
        Builder &SetPixelAspectRatio(
            const HdFloatDataSourceHandle &pixelAspectRatio);
        HD_API
        Builder &SetAspectRatioConformPolicy(
            const HdTokenDataSourceHandle &aspectRatioConformPolicy);
        HD_API
        Builder &SetApertureSize(
            const HdVec2fDataSourceHandle &apertureSize);
        HD_API
        Builder &SetDataWindowNDC(
            const HdVec4fDataSourceHandle &dataWindowNDC);
        HD_API
        Builder &SetDisableMotionBlur(
            const HdBoolDataSourceHandle &disableMotionBlur);
        HD_API
        Builder &SetDisableDepthOfField(
            const HdBoolDataSourceHandle &disableDepthOfField);
        HD_API
        Builder &SetNamespacedSettings(
            const HdContainerDataSourceHandle &namespacedSettings);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdPathDataSourceHandle _path;
        HdTokenDataSourceHandle _type;
        HdTokenDataSourceHandle _name;
        HdVec2iDataSourceHandle _resolution;
        HdVectorDataSourceHandle _renderVars;
        HdPathDataSourceHandle _cameraPrim;
        HdFloatDataSourceHandle _pixelAspectRatio;
        HdTokenDataSourceHandle _aspectRatioConformPolicy;
        HdVec2fDataSourceHandle _apertureSize;
        HdVec4fDataSourceHandle _dataWindowNDC;
        HdBoolDataSourceHandle _disableMotionBlur;
        HdBoolDataSourceHandle _disableDepthOfField;
        HdContainerDataSourceHandle _namespacedSettings;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif