materialAPI.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef USDRI_GENERATED_MATERIALAPI_H
#define USDRI_GENERATED_MATERIALAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdRi/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdRi/tokens.h"
 
#include "pxr/usd/usdShade/input.h"
#include "pxr/usd/usdShade/output.h"
#include "pxr/usd/usdShade/material.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;
 
// -------------------------------------------------------------------------- //
// RIMATERIALAPI                                                              //
// -------------------------------------------------------------------------- //
 
class UsdRiMaterialAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
 
    explicit UsdRiMaterialAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }
 
    explicit UsdRiMaterialAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }
 
    USDRI_API
    virtual ~UsdRiMaterialAPI();
 
    USDRI_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDRI_API
    static UsdRiMaterialAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
    USDRI_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
 
    USDRI_API
    static UsdRiMaterialAPI 
    Apply(const UsdPrim &prim);
 
protected:
    USDRI_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDRI_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDRI_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // SURFACE 
    // --------------------------------------------------------------------- //
    USDRI_API
    UsdAttribute GetSurfaceAttr() const;
 
    USDRI_API
    UsdAttribute CreateSurfaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DISPLACEMENT 
    // --------------------------------------------------------------------- //
    USDRI_API
    UsdAttribute GetDisplacementAttr() const;
 
    USDRI_API
    UsdAttribute CreateDisplacementAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // VOLUME 
    // --------------------------------------------------------------------- //
    USDRI_API
    UsdAttribute GetVolumeAttr() const;
 
    USDRI_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)--
 
    explicit UsdRiMaterialAPI(const UsdShadeMaterial& material)
        : UsdRiMaterialAPI(material.GetPrim())
    {
    }
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
        
    USDRI_API
    UsdShadeOutput GetSurfaceOutput() const;
 
    USDRI_API
    UsdShadeOutput GetDisplacementOutput() const;
 
    USDRI_API
    UsdShadeOutput GetVolumeOutput() const;
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
        
    USDRI_API
    bool SetSurfaceSource(const SdfPath &surfacePath) const;
    
    USDRI_API
    bool SetDisplacementSource(const SdfPath &displacementPath) const;
 
    USDRI_API
    bool SetVolumeSource(const SdfPath &volumePath) const;
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
        
    USDRI_API
    UsdShadeShader GetSurface(bool ignoreBaseMaterial=false) const;
 
    USDRI_API
    UsdShadeShader GetDisplacement(bool ignoreBaseMaterial=false) const;
 
    USDRI_API
    UsdShadeShader GetVolume(bool ignoreBaseMaterial=false) const;
 
 
 
    USDRI_API
    UsdShadeNodeGraph::InterfaceInputConsumersMap
    ComputeInterfaceInputConsumersMap(
            bool computeTransitiveConsumers=false) const;
 
 
private:
    UsdShadeShader _GetSourceShaderObject(const UsdShadeOutput &output,
                                          bool ignoreBaseMaterial) const;
 
    // Helper method to get the deprecated 'bxdf' output.
    UsdShadeOutput _GetBxdfOutput(const UsdPrim &materialPrim) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif