backPlateSchema.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_BACK_PLATE_SCHEMA_H
#define PXR_IMAGING_HD_BACK_PLATE_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)--

PXR_NAMESPACE_OPEN_SCOPE

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

#define HD_BACK_PLATE_SCHEMA_TOKENS \
    (backPlate) \
    (scaleTweak) \
    (rotateXYZTweak) \
    (translateTweak) \
    (image) \
    (alphaImage) \
    (depthImage) \
    (depthMinOffset) \
    (depthNormalizingFactor) \
    (depthCameraSpaceOffset) \
    (lumaSlope) \
    (lumaOffset) \
    (lumaPower) \
    (plateVisibility) \
    (all) \
    (solo) \
    (none) \

TF_DECLARE_PUBLIC_TOKENS(HdBackPlateSchemaTokens, HD_API,
    HD_BACK_PLATE_SCHEMA_TOKENS);

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


class HdBackPlateSchema : public HdSchema
{
public:

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

    HD_API
    static HdBackPlateSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    HD_API
    HdVec2fDataSourceHandle GetScaleTweak() const;

    HD_API
    HdVec3fDataSourceHandle GetRotateXYZTweak() const;

    HD_API
    HdVec3fDataSourceHandle GetTranslateTweak() const;

    HD_API
    HdAssetPathDataSourceHandle GetImage() const;

    HD_API
    HdAssetPathDataSourceHandle GetAlphaImage() const;

    HD_API
    HdAssetPathDataSourceHandle GetDepthImage() const;

    HD_API
    HdFloatDataSourceHandle GetDepthMinOffset() const;

    HD_API
    HdFloatDataSourceHandle GetDepthNormalizingFactor() const;

    HD_API
    HdFloatDataSourceHandle GetDepthCameraSpaceOffset() const;

    HD_API
    HdVec3fDataSourceHandle GetLumaSlope() const;

    HD_API
    HdVec3fDataSourceHandle GetLumaOffset() const;

    HD_API
    HdVec3fDataSourceHandle GetLumaPower() const;

    HD_API
    HdTokenDataSourceHandle GetPlateVisibility() const; 



    HD_API
    static const TfToken &GetSchemaToken();



    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdVec2fDataSourceHandle &scaleTweak,
        const HdVec3fDataSourceHandle &rotateXYZTweak,
        const HdVec3fDataSourceHandle &translateTweak,
        const HdAssetPathDataSourceHandle &image,
        const HdAssetPathDataSourceHandle &alphaImage,
        const HdAssetPathDataSourceHandle &depthImage,
        const HdFloatDataSourceHandle &depthMinOffset,
        const HdFloatDataSourceHandle &depthNormalizingFactor,
        const HdFloatDataSourceHandle &depthCameraSpaceOffset,
        const HdVec3fDataSourceHandle &lumaSlope,
        const HdVec3fDataSourceHandle &lumaOffset,
        const HdVec3fDataSourceHandle &lumaPower,
        const HdTokenDataSourceHandle &plateVisibility
    );

    class Builder
    {
    public:
        HD_API
        Builder &SetScaleTweak(
            const HdVec2fDataSourceHandle &scaleTweak);
        HD_API
        Builder &SetRotateXYZTweak(
            const HdVec3fDataSourceHandle &rotateXYZTweak);
        HD_API
        Builder &SetTranslateTweak(
            const HdVec3fDataSourceHandle &translateTweak);
        HD_API
        Builder &SetImage(
            const HdAssetPathDataSourceHandle &image);
        HD_API
        Builder &SetAlphaImage(
            const HdAssetPathDataSourceHandle &alphaImage);
        HD_API
        Builder &SetDepthImage(
            const HdAssetPathDataSourceHandle &depthImage);
        HD_API
        Builder &SetDepthMinOffset(
            const HdFloatDataSourceHandle &depthMinOffset);
        HD_API
        Builder &SetDepthNormalizingFactor(
            const HdFloatDataSourceHandle &depthNormalizingFactor);
        HD_API
        Builder &SetDepthCameraSpaceOffset(
            const HdFloatDataSourceHandle &depthCameraSpaceOffset);
        HD_API
        Builder &SetLumaSlope(
            const HdVec3fDataSourceHandle &lumaSlope);
        HD_API
        Builder &SetLumaOffset(
            const HdVec3fDataSourceHandle &lumaOffset);
        HD_API
        Builder &SetLumaPower(
            const HdVec3fDataSourceHandle &lumaPower);
        HD_API
        Builder &SetPlateVisibility(
            const HdTokenDataSourceHandle &plateVisibility);

        HD_API
        HdContainerDataSourceHandle Build();

    private:
        HdVec2fDataSourceHandle _scaleTweak;
        HdVec3fDataSourceHandle _rotateXYZTweak;
        HdVec3fDataSourceHandle _translateTweak;
        HdAssetPathDataSourceHandle _image;
        HdAssetPathDataSourceHandle _alphaImage;
        HdAssetPathDataSourceHandle _depthImage;
        HdFloatDataSourceHandle _depthMinOffset;
        HdFloatDataSourceHandle _depthNormalizingFactor;
        HdFloatDataSourceHandle _depthCameraSpaceOffset;
        HdVec3fDataSourceHandle _lumaSlope;
        HdVec3fDataSourceHandle _lumaOffset;
        HdVec3fDataSourceHandle _lumaPower;
        HdTokenDataSourceHandle _plateVisibility;

    };

    HD_API
    static HdTokenDataSourceHandle BuildPlateVisibilityDataSource(
        const TfToken &plateVisibility);

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif