usdRenderVarSchema.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_VAR_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_VAR_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_VAR_SCHEMA_TOKENS \
    (__usdRenderVar) \
    (dataType) \
    (sourceName) \
    (sourceType) \
    (namespacedSettings) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderVarSchemaTokens, USDIMAGING_API,
    USD_IMAGING_USD_RENDER_VAR_SCHEMA_TOKENS);

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


class UsdImagingUsdRenderVarSchema : public HdSchema
{
public:

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

    USDIMAGING_API
    static UsdImagingUsdRenderVarSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    USDIMAGING_API
    HdTokenDataSourceHandle GetDataType() const;

    USDIMAGING_API
    HdStringDataSourceHandle GetSourceName() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetSourceType() const;

    USDIMAGING_API
    HdContainerDataSourceHandle GetNamespacedSettings() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static const HdDataSourceLocator &GetNamespacedSettingsLocator();


    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdTokenDataSourceHandle &dataType,
        const HdStringDataSourceHandle &sourceName,
        const HdTokenDataSourceHandle &sourceType,
        const HdContainerDataSourceHandle &namespacedSettings
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetDataType(
            const HdTokenDataSourceHandle &dataType);
        USDIMAGING_API
        Builder &SetSourceName(
            const HdStringDataSourceHandle &sourceName);
        USDIMAGING_API
        Builder &SetSourceType(
            const HdTokenDataSourceHandle &sourceType);
        USDIMAGING_API
        Builder &SetNamespacedSettings(
            const HdContainerDataSourceHandle &namespacedSettings);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdTokenDataSourceHandle _dataType;
        HdStringDataSourceHandle _sourceName;
        HdTokenDataSourceHandle _sourceType;
        HdContainerDataSourceHandle _namespacedSettings;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif