collectionMaterialBindingSchema.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_COLLECTION_MATERIAL_BINDING_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_COLLECTION_MATERIAL_BINDING_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_COLLECTION_MATERIAL_BINDING_SCHEMA_TOKENS \
    (collectionMaterialBinding) \
    (collectionPrimPath) \
    (collectionName) \
    (materialPath) \
    (bindingStrength) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingCollectionMaterialBindingSchemaTokens, USDIMAGING_API,
    USD_IMAGING_COLLECTION_MATERIAL_BINDING_SCHEMA_TOKENS);

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


class UsdImagingCollectionMaterialBindingSchema : public HdSchema
{
public:

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

    USDIMAGING_API
    static UsdImagingCollectionMaterialBindingSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    USDIMAGING_API
    HdPathDataSourceHandle GetCollectionPrimPath() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetCollectionName() const;

    USDIMAGING_API
    HdPathDataSourceHandle GetMaterialPath() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetBindingStrength() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &collectionPrimPath,
        const HdTokenDataSourceHandle &collectionName,
        const HdPathDataSourceHandle &materialPath,
        const HdTokenDataSourceHandle &bindingStrength
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetCollectionPrimPath(
            const HdPathDataSourceHandle &collectionPrimPath);
        USDIMAGING_API
        Builder &SetCollectionName(
            const HdTokenDataSourceHandle &collectionName);
        USDIMAGING_API
        Builder &SetMaterialPath(
            const HdPathDataSourceHandle &materialPath);
        USDIMAGING_API
        Builder &SetBindingStrength(
            const HdTokenDataSourceHandle &bindingStrength);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdPathDataSourceHandle _collectionPrimPath;
        HdTokenDataSourceHandle _collectionName;
        HdPathDataSourceHandle _materialPath;
        HdTokenDataSourceHandle _bindingStrength;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif