claimsAPI.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef USDPROFILES_GENERATED_CLAIMSAPI_H
#define USDPROFILES_GENERATED_CLAIMSAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdProfiles/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
 
#include "pxr/usd/usdProfiles/profileRegistry.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/array.h"
#include "pxr/base/vt/dictionary.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;
 
// -------------------------------------------------------------------------- //
// CLAIMSAPI                                                                  //
// -------------------------------------------------------------------------- //
 
class UsdProfilesClaimsAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
 
    explicit UsdProfilesClaimsAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }
 
    explicit UsdProfilesClaimsAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }
 
    USDPROFILES_API
    virtual ~UsdProfilesClaimsAPI();
 
    USDPROFILES_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDPROFILES_API
    static UsdProfilesClaimsAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
    USDPROFILES_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
 
    USDPROFILES_API
    static UsdProfilesClaimsAPI 
    Apply(const UsdPrim &prim);
 
protected:
    USDPROFILES_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDPROFILES_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDPROFILES_API
    const TfType &_GetTfType() const override;
 
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)--
 
 
    // ---------------------------------------------------------------------- //
    // Raw dictionary access
    // ---------------------------------------------------------------------- //
 
    USDPROFILES_API
    VtDictionary GetProfilesInfo() const;
 
    USDPROFILES_API
    void SetProfilesInfo(const VtDictionary &info) const;
 
    // ---------------------------------------------------------------------- //
    // Capability Usage (DCC-authored tier)
    // ---------------------------------------------------------------------- //
 
    USDPROFILES_API
    VtDictionary GetCapabilityUsages() const;
 
    USDPROFILES_API
    void SetCapabilityUsages(const VtDictionary &usages) const;
 
    USDPROFILES_API
    void SetCapabilityUsage(const TfToken &capability,
                            const TfToken &degradationClass) const;
 
    USDPROFILES_API
    TfToken GetCapabilityUsage(const TfToken &capability) const;
 
    // ---------------------------------------------------------------------- //
    // Profile Compatibility (pipeline-authored tier)
    // ---------------------------------------------------------------------- //
 
    USDPROFILES_API
    VtArray<TfToken> GetCompatibleProfiles() const;
 
    USDPROFILES_API
    void SetProfileCompatible(const TfToken &profile) const;
 
    USDPROFILES_API
    void SetProfileCompatibleWithExceptions(
        const TfToken &profile,
        const VtArray<TfToken> &exceptions) const;
 
    USDPROFILES_API
    VtArray<TfToken> GetProfileExceptions(const TfToken &profile) const;
 
    USDPROFILES_API
    void ClearProfileCompatibility(const TfToken &profile) const;
 
    // ---------------------------------------------------------------------- //
    // Compatibility query
    // ---------------------------------------------------------------------- //
 
    USDPROFILES_API
    UsdProfileRegistry::QueryStatus IsCompatibleWith(
        const TfToken &profile,
        std::vector<UsdProfileRegistry::CapabilityResult> *results = nullptr)
        const;
 
 
private:
    template <typename T>
    bool _GetProfilesInfoByKey(const TfToken &keyPath, T *val) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif