Loading...
Searching...
No Matches
skeletonSchema.h
Go to the documentation of this file.
1//
2// Copyright 2025 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef PXR_USD_IMAGING_USD_SKEL_IMAGING_SKELETON_SCHEMA_H
19#define PXR_USD_IMAGING_USD_SKEL_IMAGING_SKELETON_SCHEMA_H
20
22
23#include "pxr/usdImaging/usdSkelImaging/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define USD_SKEL_IMAGING_SKELETON_SCHEMA_TOKENS \
36 (skeleton) \
37 (joints) \
38 (jointNames) \
39 (bindTransforms) \
40 (restTransforms) \
41
42TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingSkeletonSchemaTokens, USDSKELIMAGING_API,
43 USD_SKEL_IMAGING_SKELETON_SCHEMA_TOKENS);
44
45//-----------------------------------------------------------------------------
46
47// Corresponds to UsdSkelSkeleton.
48//
49
50class UsdSkelImagingSkeletonSchema : public HdSchema
51{
52public:
55
56 UsdSkelImagingSkeletonSchema(HdContainerDataSourceHandle container)
57 : HdSchema(container) {}
58
64 USDSKELIMAGING_API
65 static UsdSkelImagingSkeletonSchema GetFromParent(
66 const HdContainerDataSourceHandle &fromParentContainer);
67
69
70// --(BEGIN CUSTOM CODE: Schema Methods)--
71// --(END CUSTOM CODE: Schema Methods)--
72
75
77 USDSKELIMAGING_API
78 HdTokenArrayDataSourceHandle GetJoints() const;
79
82 USDSKELIMAGING_API
83 HdTokenArrayDataSourceHandle GetJointNames() const;
84
85 USDSKELIMAGING_API
86 HdMatrixArrayDataSourceHandle GetBindTransforms() const;
87
89 USDSKELIMAGING_API
90 HdMatrixArrayDataSourceHandle GetRestTransforms() const;
91
93
96
99 USDSKELIMAGING_API
100 static const TfToken &GetSchemaToken();
101
104 USDSKELIMAGING_API
105 static const HdDataSourceLocator &GetDefaultLocator();
106
108
117
119 USDSKELIMAGING_API
120 static const HdDataSourceLocator &GetJointsLocator();
121
123 USDSKELIMAGING_API
124 static const HdDataSourceLocator &GetJointNamesLocator();
125
127 USDSKELIMAGING_API
128 static const HdDataSourceLocator &GetBindTransformsLocator();
129
131 USDSKELIMAGING_API
132 static const HdDataSourceLocator &GetRestTransformsLocator();
134
137
145 USDSKELIMAGING_API
146 static HdContainerDataSourceHandle
147 BuildRetained(
148 const HdTokenArrayDataSourceHandle &joints,
149 const HdTokenArrayDataSourceHandle &jointNames,
150 const HdMatrixArrayDataSourceHandle &bindTransforms,
151 const HdMatrixArrayDataSourceHandle &restTransforms
152 );
153
161 {
162 public:
163 USDSKELIMAGING_API
164 Builder &SetJoints(
165 const HdTokenArrayDataSourceHandle &joints);
166 USDSKELIMAGING_API
167 Builder &SetJointNames(
168 const HdTokenArrayDataSourceHandle &jointNames);
169 USDSKELIMAGING_API
170 Builder &SetBindTransforms(
171 const HdMatrixArrayDataSourceHandle &bindTransforms);
172 USDSKELIMAGING_API
173 Builder &SetRestTransforms(
174 const HdMatrixArrayDataSourceHandle &restTransforms);
175
177 USDSKELIMAGING_API
178 HdContainerDataSourceHandle Build();
179
180 private:
181 HdTokenArrayDataSourceHandle _joints;
182 HdTokenArrayDataSourceHandle _jointNames;
183 HdMatrixArrayDataSourceHandle _bindTransforms;
184 HdMatrixArrayDataSourceHandle _restTransforms;
185
186 };
187
189};
190
191PXR_NAMESPACE_CLOSE_SCOPE
192
193#endif
Represents an object that can identify the location of a data source.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
USDSKELIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81