skeletonQuery.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 PXR_USD_USD_SKEL_SKELETON_QUERY_H
#define PXR_USD_USD_SKEL_SKELETON_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/usd/prim.h"

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


PXR_NAMESPACE_OPEN_SCOPE

class UsdGeomXformCache;
class UsdSkelSkeleton;
class UsdSkelTopology;

TF_DECLARE_REF_PTRS(UsdSkel_SkelDefinition);


class UsdSkelSkeletonQuery
{
public:
    UsdSkelSkeletonQuery() {}

    bool IsValid() const { return _definition; }

    explicit operator bool() const { return IsValid(); }

    friend bool operator==(const UsdSkelSkeletonQuery& lhs,
                           const UsdSkelSkeletonQuery& rhs) {
        return lhs._definition == rhs._definition &&
               lhs._animQuery == rhs._animQuery;
    }

    friend bool operator!=(const UsdSkelSkeletonQuery& lhs,
                           const UsdSkelSkeletonQuery& rhs) {
        return !(lhs == rhs);
    }

    USDSKEL_API
    bool HasBindPose() const;

    USDSKEL_API
    bool HasRestPose() const;

    // hash_value overload for std/boost hash.
    USDSKEL_API
    friend size_t hash_value(const UsdSkelSkeletonQuery& query);

    USDSKEL_API
    UsdPrim GetPrim() const;

    USDSKEL_API
    const UsdSkelSkeleton& GetSkeleton() const;
    
    USDSKEL_API
    const UsdSkelAnimQuery& GetAnimQuery() const;
    
    USDSKEL_API
    const UsdSkelTopology& GetTopology() const;

    USDSKEL_API
    const UsdSkelAnimMapper& GetMapper() const;

    USDSKEL_API
    VtTokenArray GetJointOrder() const;

    template <typename Matrix4>
    USDSKEL_API
    bool ComputeJointLocalTransforms(VtArray<Matrix4>* xforms,
                                     UsdTimeCode time,
                                     bool atRest=false) const;

    template <typename Matrix4>
    USDSKEL_API
    bool ComputeJointSkelTransforms(VtArray<Matrix4>* xforms,
                                    UsdTimeCode time,
                                    bool atRest=false) const;

    template <typename Matrix4>
    USDSKEL_API
    bool ComputeJointRestRelativeTransforms(VtArray<Matrix4>* xforms,
                                            UsdTimeCode time) const;

    template <typename Matrix4>
    USDSKEL_API
    bool ComputeJointWorldTransforms(VtArray<Matrix4>* xforms,
                                     UsdGeomXformCache* xfCache,
                                     bool atRest=false) const;

    template <typename Matrix4>
    USDSKEL_API
    bool ComputeSkinningTransforms(VtArray<Matrix4>* xforms,
                                   UsdTimeCode time) const;

    template <typename Matrix4>
    USDSKEL_API
    bool GetJointWorldBindTransforms(VtArray<Matrix4>* xforms) const;

    USDSKEL_API
    std::string GetDescription() const;

private:

    USDSKEL_API
    UsdSkelSkeletonQuery(const UsdSkel_SkelDefinitionRefPtr& definition,
                         const UsdSkelAnimQuery& anim=UsdSkelAnimQuery());

    bool _HasMappableAnim() const;

    template <typename Matrix4>
    bool _ComputeJointLocalTransforms(VtArray<Matrix4>* xforms,
                                      UsdTimeCode time,
                                      bool atRest=false) const;

    template <typename Matrix4>
    bool _ComputeJointSkelTransforms(VtArray<Matrix4>* xforms,
                                     UsdTimeCode time,
                                     bool atRest=false) const;

    template <typename Matrix4>
    bool _ComputeSkinningTransforms(VtArray<Matrix4>* xforms,
                                    UsdTimeCode time) const;

private:
    UsdSkel_SkelDefinitionRefPtr _definition;
    UsdSkelAnimQuery _animQuery;
    UsdSkelAnimMapper _animToSkelMapper;

    friend class UsdSkel_CacheImpl;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_SKEL_SKELETON_QUERY_H