materialBindingSchema.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_MATERIAL_BINDING_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_MATERIAL_BINDING_SCHEMA_H
 
 
#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/usdImaging/usdImaging/directMaterialBindingSchema.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
#include "pxr/imaging/hd/vectorSchema.h"
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
using UsdImagingCollectionMaterialBindingVectorSchema =
    HdSchemaBasedVectorSchema<class UsdImagingCollectionMaterialBindingSchema>;
// --(END CUSTOM CODE: Declares)--
 
#define USD_IMAGING_MATERIAL_BINDING_SCHEMA_TOKENS \
    (usdMaterialBinding) \
    (directMaterialBinding) \
    (collectionMaterialBindings) \
 
TF_DECLARE_PUBLIC_TOKENS(UsdImagingMaterialBindingSchemaTokens, USDIMAGING_API,
    USD_IMAGING_MATERIAL_BINDING_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// The UsdImagingMaterialBindingSchema specifies a container for a prim's
// material bindings for a particular purpose. Note that only one direct
// binding but any number of collection-based bindings may be declared for a
// given purpose. See UsdImagingMaterialBindingsSchema which specifies the
// purposes and their associated bindings.
//
 
class UsdImagingMaterialBindingSchema : public HdSchema
{
public:
 
    UsdImagingMaterialBindingSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    USDIMAGING_API
    static UsdImagingMaterialBindingSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    USDIMAGING_API
    UsdImagingDirectMaterialBindingSchema GetDirectMaterialBinding() const;
 
    USDIMAGING_API
    UsdImagingCollectionMaterialBindingVectorSchema GetCollectionMaterialBindings() const; 
 
 
 
    USDIMAGING_API
    static const TfToken &GetSchemaToken();
 
    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdContainerDataSourceHandle &directMaterialBinding,
        const HdVectorDataSourceHandle &collectionMaterialBindings
    );
 
    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetDirectMaterialBinding(
            const HdContainerDataSourceHandle &directMaterialBinding);
        USDIMAGING_API
        Builder &SetCollectionMaterialBindings(
            const HdVectorDataSourceHandle &collectionMaterialBindings);
 
        USDIMAGING_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdContainerDataSourceHandle _directMaterialBinding;
        HdVectorDataSourceHandle _collectionMaterialBindings;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif