cache.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 PXR_USD_USD_SKEL_CACHE_H
#define PXR_USD_USD_SKEL_CACHE_H


#include "pxr/pxr.h"
#include "pxr/usd/usdSkel/api.h"

#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/primFlags.h"

#include "pxr/usd/usdSkel/animQuery.h"
#include "pxr/usd/usdSkel/binding.h"

#include <memory>


PXR_NAMESPACE_OPEN_SCOPE


class UsdSkelRoot;
class UsdSkelAnimation;
class UsdSkelSkeleton;
class UsdSkelSkeletonQuery;
class UsdSkelSkinningQuery;

TF_DECLARE_REF_PTRS(UsdSkelBinding);


class UsdSkelCache
{
public:
    USDSKEL_API
    UsdSkelCache();

    USDSKEL_API
    void Clear();

    USDSKEL_API
    bool Populate(const UsdSkelRoot& root,
                  Usd_PrimFlagsPredicate predicate) const;

    USDSKEL_API
    UsdSkelSkeletonQuery GetSkelQuery(const UsdSkelSkeleton& skel) const;

    USDSKEL_API
    UsdSkelAnimQuery GetAnimQuery(const UsdSkelAnimation& anim) const;

    USDSKEL_API
    UsdSkelAnimQuery GetAnimQuery(const UsdPrim& prim) const;

    USDSKEL_API
    UsdSkelSkinningQuery GetSkinningQuery(const UsdPrim& prim) const;

    USDSKEL_API
    bool ComputeSkelBindings(const UsdSkelRoot& skelRoot,
                             std::vector<UsdSkelBinding>* bindings,
                             Usd_PrimFlagsPredicate predicate) const;

    USDSKEL_API
    bool ComputeSkelBinding(const UsdSkelRoot& skelRoot,
                            const UsdSkelSkeleton& skel,
                            UsdSkelBinding* binding,
                            Usd_PrimFlagsPredicate predicate) const;

private:
    std::shared_ptr<class UsdSkel_CacheImpl> _impl;
 
    friend class UsdSkelAnimQuery;
    friend class UsdSkelSkeletonQuery;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // USDSKEL_EVALCACHE_H