animQuery.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_ANIM_QUERY_H
#define PXR_USD_USD_SKEL_ANIM_QUERY_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdSkel/api.h"
 
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/vt/types.h"
 
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/timeCode.h"
 
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class GfMatrix4d;
class UsdAttribute;
class UsdSkelCache;
 
 
TF_DECLARE_REF_PTRS(UsdSkel_AnimQueryImpl);
 
 
class UsdSkelAnimQuery
{
public:
    USDSKEL_API
    UsdSkelAnimQuery() {}
 
    bool IsValid() const { return (bool)_impl; }
 
    explicit operator bool() const { return IsValid(); }
 
    friend bool operator==(const UsdSkelAnimQuery& lhs,
                           const UsdSkelAnimQuery& rhs) {
        return lhs.GetPrim() == rhs.GetPrim();
    }
 
    friend bool operator!=(const UsdSkelAnimQuery& lhs,
                           const UsdSkelAnimQuery& rhs) {
        return !(lhs == rhs);
    }
 
    // hash_value overload for std/boost hash.
    friend size_t hash_value(const UsdSkelAnimQuery& query) {
        return hash_value(query.GetPrim());
    }
 
    USDSKEL_API
    UsdPrim GetPrim() const;
 
    template <typename Matrix4>
    USDSKEL_API
    bool ComputeJointLocalTransforms(
             VtArray<Matrix4>* xforms,
             UsdTimeCode time=UsdTimeCode::Default()) const;
 
    USDSKEL_API
    bool ComputeJointLocalTransformComponents(
             VtVec3fArray* translations,    
             VtQuatfArray* rotations,
             VtVec3hArray* scales,
             UsdTimeCode time=UsdTimeCode::Default()) const;
 
    USDSKEL_API
    bool ComputeBlendShapeWeights(
             VtFloatArray* weights,
             UsdTimeCode time=UsdTimeCode::Default()) const;
    
    USDSKEL_API
    bool GetJointTransformTimeSamples(std::vector<double>* times) const;
 
    USDSKEL_API
    bool GetJointTransformTimeSamplesInInterval(const GfInterval& interval,
                                                std::vector<double>* times) const;
 
    USDSKEL_API
    bool GetJointTransformAttributes(std::vector<UsdAttribute>* attrs) const;
 
    USDSKEL_API
    bool JointTransformsMightBeTimeVarying() const;
 
    USDSKEL_API
    bool GetBlendShapeWeightTimeSamples(std::vector<double>* attrs) const;
 
    USDSKEL_API
    bool GetBlendShapeWeightTimeSamplesInInterval(const GfInterval& interval,
                                                  std::vector<double>* times) const;
 
    USDSKEL_API
    bool GetBlendShapeWeightAttributes(std::vector<UsdAttribute>* attrs) const;
 
    USDSKEL_API
    bool BlendShapeWeightsMightBeTimeVarying() const;
 
    USDSKEL_API
    VtTokenArray GetJointOrder() const;
 
    USDSKEL_API
    VtTokenArray GetBlendShapeOrder() const;
 
    USDSKEL_API
    std::string GetDescription() const;
 
private:
    UsdSkelAnimQuery(const UsdSkel_AnimQueryImplRefPtr& impl)
        :  _impl(impl) {}
 
    UsdSkel_AnimQueryImplRefPtr _impl;
 
    friend class UsdSkel_CacheImpl;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_SKEL_ANIM_QUERY_H