material.h

Go to the documentation of this file.

//
// Copyright 2016 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.
//
#ifndef USDSHADE_GENERATED_MATERIAL_H
#define USDSHADE_GENERATED_MATERIAL_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdShade/api.h"
#include "pxr/usd/usdShade/nodeGraph.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdShade/tokens.h"
 
#include "pxr/usd/usd/variantSets.h"
#include "pxr/usd/usdGeom/subset.h"
#include "pxr/usd/usdShade/connectableAPI.h"
 
#include "pxr/base/vt/value.h"
 
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"
 
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfAssetPath;
 
// -------------------------------------------------------------------------- //
// MATERIAL                                                                   //
// -------------------------------------------------------------------------- //
 
class UsdShadeMaterial : public UsdShadeNodeGraph
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
 
    explicit UsdShadeMaterial(const UsdPrim& prim=UsdPrim())
        : UsdShadeNodeGraph(prim)
    {
    }
 
    explicit UsdShadeMaterial(const UsdSchemaBase& schemaObj)
        : UsdShadeNodeGraph(schemaObj)
    {
    }
 
    USDSHADE_API
    virtual ~UsdShadeMaterial();
 
    USDSHADE_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDSHADE_API
    static UsdShadeMaterial
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
    USDSHADE_API
    static UsdShadeMaterial
    Define(const UsdStagePtr &stage, const SdfPath &path);
 
protected:
    USDSHADE_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDSHADE_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDSHADE_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // SURFACE 
    // --------------------------------------------------------------------- //
    USDSHADE_API
    UsdAttribute GetSurfaceAttr() const;
 
    USDSHADE_API
    UsdAttribute CreateSurfaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DISPLACEMENT 
    // --------------------------------------------------------------------- //
    USDSHADE_API
    UsdAttribute GetDisplacementAttr() const;
 
    USDSHADE_API
    UsdAttribute CreateDisplacementAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // VOLUME 
    // --------------------------------------------------------------------- //
    USDSHADE_API
    UsdAttribute GetVolumeAttr() const;
 
    USDSHADE_API
    UsdAttribute CreateVolumeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    typedef std::function<bool (const SdfPath &)> PathPredicate;
 
 
 
    // --------------------------------------------------------------------- //
        
    USDSHADE_API 
    UsdShadeOutput CreateSurfaceOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API
    UsdShadeOutput GetSurfaceOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API
    std::vector<UsdShadeOutput> GetSurfaceOutputs() const;
 
    USDSHADE_API
    UsdShadeShader ComputeSurfaceSource(
        const TfToken &renderContext,
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
    USDSHADE_API
    UsdShadeShader ComputeSurfaceSource(
        const TfTokenVector &contextVector={UsdShadeTokens->universalRenderContext},
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
    USDSHADE_API 
    UsdShadeOutput CreateDisplacementOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API 
    UsdShadeOutput GetDisplacementOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API
    std::vector<UsdShadeOutput> GetDisplacementOutputs() const;
 
    USDSHADE_API
    UsdShadeShader ComputeDisplacementSource(
        const TfToken &renderContext,
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
    USDSHADE_API
    UsdShadeShader ComputeDisplacementSource(
        const TfTokenVector &contextVector={UsdShadeTokens->universalRenderContext},
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
    USDSHADE_API 
    UsdShadeOutput CreateVolumeOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API 
    UsdShadeOutput GetVolumeOutput(const TfToken &renderContext
            =UsdShadeTokens->universalRenderContext) const;
 
    USDSHADE_API
    std::vector<UsdShadeOutput> GetVolumeOutputs() const;
 
    USDSHADE_API
    UsdShadeShader ComputeVolumeSource(
        const TfToken &renderContext,
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
    USDSHADE_API
    UsdShadeShader ComputeVolumeSource(
        const TfTokenVector &contextVector={UsdShadeTokens->universalRenderContext},
        TfToken *sourceName=nullptr, 
        UsdShadeAttributeType *sourceType=nullptr) const;
 
 
private:
    // Helper method to compute the sources of a given output, identified by its 
    // baseName, for the renderContexts in the specified contextVector.
    UsdShadeAttributeVector _ComputeNamedOutputSources(
        const TfToken &baseName,
        const TfTokenVector &contextVector) const;
 
    // Helper method to compute the source shader of a given output, identified 
    // by its baseName, for the renderContexts in the specified contextVector.
    UsdShadeShader _ComputeNamedOutputShader(
        const TfToken &baseName,
        const TfTokenVector &contextVector,
        TfToken *sourceName,
        UsdShadeAttributeType *sourceType) const;
 
    // Helper method to retrieve outputs in all renderContexts that match the
    // given terminalName.
    std::vector<UsdShadeOutput> _GetOutputsForTerminalName(
        const TfToken& terminalName) const;
 
public:
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
    USDSHADE_API
    std::pair<UsdStagePtr, UsdEditTarget>
    GetEditContextForVariant(const TfToken &MaterialVariantName,
                             const SdfLayerHandle &layer = SdfLayerHandle()) const;
    
    USDSHADE_API
    UsdVariantSet GetMaterialVariant() const;
 
    USDSHADE_API
    static bool CreateMasterMaterialVariant(
        const UsdPrim &masterPrim,
        const std::vector<UsdPrim> &MaterialPrims,
        const TfToken &masterVariantSetName = TfToken());
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    USDSHADE_API
    UsdShadeMaterial GetBaseMaterial() const;
 
    USDSHADE_API
    SdfPath GetBaseMaterialPath() const;
 
    USDSHADE_API
    static SdfPath FindBaseMaterialPathInPrimIndex(
        const PcpPrimIndex & primIndex,
        const PathPredicate & pathIsMaterialPredicate);
 
    USDSHADE_API
    void SetBaseMaterial(const UsdShadeMaterial& baseMaterial) const;
 
    USDSHADE_API
    void SetBaseMaterialPath(const SdfPath& baseMaterialPath) const;
 
    USDSHADE_API
    void ClearBaseMaterial() const;
 
    // Check if this Material has a base Material
    USDSHADE_API
    bool HasBaseMaterial() const;
 
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif