materialSchema.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_MATERIAL_SCHEMA_H
#define PXR_IMAGING_HD_MATERIAL_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/materialNetworkSchema.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_MATERIAL_SCHEMA_TOKENS \
    (material) \
    ((universalRenderContext, "")) \
    ((all, "__all")) \
    (terminals) \
    (surface) \
    (displacement) \
    (volume) \
 
TF_DECLARE_PUBLIC_TOKENS(HdMaterialSchemaTokens, HD_API,
    HD_MATERIAL_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// The Material schema is a container schema that provides the correct
// material definition per render context.
//
// For example, a material may specify several render contexts like the
// universalRenderContext (""), Renderman ("ri"), Storm ("glslfx"), etc. Each
// render context will then provide the specific definition for the renderer,
// which is defined by the MaterialNetwork schema. The universalRenderContext
// applies to all renderers.
//
// See "Custom Code: Schema Methods" section for ASCII art diagram.
//
 
class HdMaterialSchema : public HdSchema
{
public:
 
    HdMaterialSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdMaterialSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
 
 
 
        
    
 
    HD_API
    HdMaterialNetworkSchema GetMaterialNetwork();
 
    HD_API
    HdMaterialNetworkSchema GetMaterialNetwork(TfToken const &context);
 
    HD_API
    HdMaterialNetworkSchema GetMaterialNetwork(TfTokenVector const &contexts);
 
    // Find the terminal (surface/volume/displcement) from a given data source locator.
    HD_API
    static TfToken
    GetLocatorTerminal(
        HdDataSourceLocator const& locator);
 
    HD_API
    static TfToken 
    GetLocatorTerminal(
        HdDataSourceLocator const& locator, 
        TfToken const& context);
 
    HD_API
    static TfToken 
    GetLocatorTerminal(
        HdDataSourceLocator const& locator, 
        TfTokenVector const &contexts);
 
// --(END CUSTOM CODE: Schema Methods)--
 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        size_t count,
        const TfToken *names,
        const HdDataSourceBaseHandle *values);
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif