blendShapeSchema.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_BLEND_SHAPE_SCHEMA_H
19 #define PXR_USD_IMAGING_USD_SKEL_IMAGING_BLEND_SHAPE_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 #include "pxr/imaging/hd/containerSchema.h"
29 // --(END CUSTOM CODE: Includes)--
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 // --(BEGIN CUSTOM CODE: Declares)--
36 // --(END CUSTOM CODE: Declares)--
37 
38 #define USD_SKEL_IMAGING_BLEND_SHAPE_SCHEMA_TOKENS \
39  (skelBlendShape) \
40  (offsets) \
41  (normalOffsets) \
42  (pointIndices) \
43  (inbetweenShapes) \
44 
45 TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingBlendShapeSchemaTokens, USDSKELIMAGING_API,
46  USD_SKEL_IMAGING_BLEND_SHAPE_SCHEMA_TOKENS);
47 
48 //-----------------------------------------------------------------------------
49 
50 
56 {
57 public:
60 
61  UsdSkelImagingBlendShapeSchema(HdContainerDataSourceHandle container)
62  : HdSchema(container) {}
63 
69  USDSKELIMAGING_API
71  const HdContainerDataSourceHandle &fromParentContainer);
72 
74 
75 // --(BEGIN CUSTOM CODE: Schema Methods)--
76 // --(END CUSTOM CODE: Schema Methods)--
77 
80 
81  USDSKELIMAGING_API
82  HdVec3fArrayDataSourceHandle GetOffsets() const;
83 
84  USDSKELIMAGING_API
85  HdVec3fArrayDataSourceHandle GetNormalOffsets() const;
86 
87  USDSKELIMAGING_API
88  HdIntArrayDataSourceHandle GetPointIndices() const;
89 
90  USDSKELIMAGING_API
91  UsdSkelImagingInbetweenShapeContainerSchema GetInbetweenShapes() const;
92 
94 
97 
100  USDSKELIMAGING_API
101  static const TfToken &GetSchemaToken();
102 
105  USDSKELIMAGING_API
106  static const HdDataSourceLocator &GetDefaultLocator();
107 
109 
118 
120  USDSKELIMAGING_API
121  static const HdDataSourceLocator &GetOffsetsLocator();
122 
124  USDSKELIMAGING_API
126 
128  USDSKELIMAGING_API
130 
132  USDSKELIMAGING_API
135 
138 
146  USDSKELIMAGING_API
147  static HdContainerDataSourceHandle
149  const HdVec3fArrayDataSourceHandle &offsets,
150  const HdVec3fArrayDataSourceHandle &normalOffsets,
151  const HdIntArrayDataSourceHandle &pointIndices,
152  const HdContainerDataSourceHandle &inbetweenShapes
153  );
154 
161  class Builder
162  {
163  public:
164  USDSKELIMAGING_API
165  Builder &SetOffsets(
166  const HdVec3fArrayDataSourceHandle &offsets);
167  USDSKELIMAGING_API
168  Builder &SetNormalOffsets(
169  const HdVec3fArrayDataSourceHandle &normalOffsets);
170  USDSKELIMAGING_API
171  Builder &SetPointIndices(
172  const HdIntArrayDataSourceHandle &pointIndices);
173  USDSKELIMAGING_API
174  Builder &SetInbetweenShapes(
175  const HdContainerDataSourceHandle &inbetweenShapes);
176 
178  USDSKELIMAGING_API
179  HdContainerDataSourceHandle Build();
180 
181  private:
182  HdVec3fArrayDataSourceHandle _offsets;
183  HdVec3fArrayDataSourceHandle _normalOffsets;
184  HdIntArrayDataSourceHandle _pointIndices;
185  HdContainerDataSourceHandle _inbetweenShapes;
186 
187  };
188 
190 };
191 
192 PXR_NAMESPACE_CLOSE_SCOPE
193 
194 #endif
Corresponds to UsdSkelBlendShape.
static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained(const HdVec3fArrayDataSourceHandle &offsets, const HdVec3fArrayDataSourceHandle &normalOffsets, const HdIntArrayDataSourceHandle &pointIndices, const HdContainerDataSourceHandle &inbetweenShapes)
static USDSKELIMAGING_API UsdSkelImagingBlendShapeSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "skelBlendShape" from the pare...
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
Represents an object that can identify the location of a data source.
static USDSKELIMAGING_API const HdDataSourceLocator & GetPointIndicesLocator()
Prim-level relative data source locator to locate pointIndices.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92
static USDSKELIMAGING_API const HdDataSourceLocator & GetNormalOffsetsLocator()
Prim-level relative data source locator to locate normalOffsets.
Template class for a schema backed by a container whose children have arbitrary names but an expected...
USDSKELIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:25
static USDSKELIMAGING_API const HdDataSourceLocator & GetOffsetsLocator()
Prim-level relative data source locator to locate offsets.
static USDSKELIMAGING_API const TfToken & GetSchemaToken()
Returns a token where the container representing this schema is found in a container by default.
static USDSKELIMAGING_API const HdDataSourceLocator & GetDefaultLocator()
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container represent...
static USDSKELIMAGING_API const HdDataSourceLocator & GetInbetweenShapesLocator()
Prim-level relative data source locator to locate inbetweenShapes.