materialNodeSchema.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_NODE_SCHEMA_H
#define PXR_IMAGING_HD_MATERIAL_NODE_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/schemaTypeDefs.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_NODE_SCHEMA_TOKENS \
    (parameters) \
    (inputConnections) \
    (nodeIdentifier) \
    (renderContextNodeIdentifiers) \
    (nodeTypeInfo) \
 
TF_DECLARE_PUBLIC_TOKENS(HdMaterialNodeSchemaTokens, HD_API,
    HD_MATERIAL_NODE_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// The MaterialNode schema is a container schema that defines a particular
// node in a material network.
//
// A material node defines its connections to other nodes via the
// "inputConnections" member. For example, "albedo" would define that it
// receives its value from its connection to the node "Color_UnPreMult" and
// the output "resultRGB" with the following data sources:
//
// ds at: material/<renderContext>/nodes/MaterialLayer/inputConnections
// /albedo/[0]/upstreamNodePath = Color_UnPreMult
//
// ds at: material/<renderContext>/nodes/MaterialLayer/inputConnections
// /albedo/[0]/upstreamNodeOutputName = resultRGB
//
 
class HdMaterialNodeSchema : public HdSchema
{
public:
 
    HdMaterialNodeSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdMaterialNodeParameterContainerSchema GetParameters() const;
 
    HD_API
    HdMaterialConnectionVectorContainerSchema GetInputConnections() const;
 
    HD_API
    HdTokenDataSourceHandle GetNodeIdentifier() const;
 
    HD_API
    HdContainerDataSourceHandle GetRenderContextNodeIdentifiers() const;
 
    HD_API
    HdContainerDataSourceHandle GetNodeTypeInfo() const; 
 
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdContainerDataSourceHandle &parameters,
        const HdContainerDataSourceHandle &inputConnections,
        const HdTokenDataSourceHandle &nodeIdentifier,
        const HdContainerDataSourceHandle &renderContextNodeIdentifiers,
        const HdContainerDataSourceHandle &nodeTypeInfo
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetParameters(
            const HdContainerDataSourceHandle &parameters);
        HD_API
        Builder &SetInputConnections(
            const HdContainerDataSourceHandle &inputConnections);
        HD_API
        Builder &SetNodeIdentifier(
            const HdTokenDataSourceHandle &nodeIdentifier);
        HD_API
        Builder &SetRenderContextNodeIdentifiers(
            const HdContainerDataSourceHandle &renderContextNodeIdentifiers);
        HD_API
        Builder &SetNodeTypeInfo(
            const HdContainerDataSourceHandle &nodeTypeInfo);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdContainerDataSourceHandle _parameters;
        HdContainerDataSourceHandle _inputConnections;
        HdTokenDataSourceHandle _nodeIdentifier;
        HdContainerDataSourceHandle _renderContextNodeIdentifiers;
        HdContainerDataSourceHandle _nodeTypeInfo;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif