usdRenderVarSchema.h

//
// Copyright 2022 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//

/* ************************************************************************** */
/* ** This file is generated by a script.  Do not edit directly.  Edit     ** */
/* ** defs.py or the (*)Schema.template.h files 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" 

PXR_NAMESPACE_OPEN_SCOPE

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

#define USDIMAGINGUSDRENDERVAR_SCHEMA_TOKENS \
    (__usdRenderVar) \
    (dataType) \
    (sourceName) \
    (sourceType) \
    (namespacedSettings) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderVarSchemaTokens, USDIMAGING_API,
    USDIMAGINGUSDRENDERVAR_SCHEMA_TOKENS);

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

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

    //ACCESSORS

    USDIMAGING_API
    HdTokenDataSourceHandle GetDataType();
    USDIMAGING_API
    HdStringDataSourceHandle GetSourceName();
    USDIMAGING_API
    HdTokenDataSourceHandle GetSourceType();
    USDIMAGING_API
    HdContainerDataSourceHandle GetNamespacedSettings();

    // RETRIEVING AND CONSTRUCTING

    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;
    };

    USDIMAGING_API
    static UsdImagingUsdRenderVarSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();


    USDIMAGING_API
    static const HdDataSourceLocator &GetNamespacedSettingsLocator();

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif