HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
binding.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_USD_SKEL_BINDING_H
25 #define PXR_USD_USD_SKEL_BINDING_H
26 
27 /// \file usdSkel/binding.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdSkel/api.h"
31 
34 
36 
37 
38 /// \class UsdSkelBinding
39 ///
40 /// Helper object that describes the binding of a skeleton to a set of
41 /// skinnable objects. The set of skinnable objects is given as
42 /// UsdSkelSkinningQuery prims, which can be used both to identify the
43 /// skinned prim as well compute skinning properties of the prim.
45 {
46 public:
48 
50  const VtArray<UsdSkelSkinningQuery>& skinningQueries)
51  : _skel(skel), _skinningQueries(skinningQueries) {}
52 
53  /// Returns the bound skeleton.
54  const UsdSkelSkeleton& GetSkeleton() const { return _skel; }
55 
56  /// Returns the set skinning targets.
58  { return _skinningQueries; }
59 
60 private:
61  UsdSkelSkeleton _skel;
62  VtArray<UsdSkelSkinningQuery> _skinningQueries;
63 };
64 
65 
67 
68 #endif // USDSKEL_SKINNING_MAP
UsdSkelBinding(const UsdSkelSkeleton &skel, const VtArray< UsdSkelSkinningQuery > &skinningQueries)
Definition: binding.h:49
const UsdSkelSkeleton & GetSkeleton() const
Returns the bound skeleton.
Definition: binding.h:54
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const VtArray< UsdSkelSkinningQuery > & GetSkinningTargets() const
Returns the set skinning targets.
Definition: binding.h:57
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
UsdSkelBinding()
Definition: binding.h:47