HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
inbetweenShapeSchema.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 //
7 ////////////////////////////////////////////////////////////////////////
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_INBETWEEN_SHAPE_SCHEMA_H
19 #define PXR_USD_IMAGING_USD_SKEL_IMAGING_INBETWEEN_SHAPE_SCHEMA_H
20 
21 /// \file
22 
24 
25 #include "pxr/imaging/hd/schema.h"
26 
27 // --(BEGIN CUSTOM CODE: Includes)--
28 // --(END CUSTOM CODE: Includes)--
29 
31 
32 // --(BEGIN CUSTOM CODE: Declares)--
33 // --(END CUSTOM CODE: Declares)--
34 
35 #define USD_SKEL_IMAGING_INBETWEEN_SHAPE_SCHEMA_TOKENS \
36  (weight) \
37  (offsets) \
38  (normalOffsets) \
39 
40 TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingInbetweenShapeSchemaTokens, USDSKELIMAGING_API,
42 
43 //-----------------------------------------------------------------------------
44 
45 // Corresponds to UsdSkelInbetweenShape. Each instance corresponds to a group
46 // of attributes on a UsdSkelBlendShape that share a prefix inbetweens:NAME.
47 //
48 
50 {
51 public:
52  /// \name Schema retrieval
53  /// @{
54 
55  UsdSkelImagingInbetweenShapeSchema(HdContainerDataSourceHandle container)
56  : HdSchema(container) {}
57 
58  /// @}
59 
60 // --(BEGIN CUSTOM CODE: Schema Methods)--
61 // --(END CUSTOM CODE: Schema Methods)--
62 
63  /// \name Member accessor
64  /// @{
65 
66  /// Corresponds to Usd attribute metadata
69 
72 
75 
76  /// @}
77 
78  /// \name Schema construction
79  /// @{
80 
81  /// \deprecated Use Builder instead.
82  ///
83  /// Builds a container data source which includes the provided child data
84  /// sources. Parameters with nullptr values are excluded. This is a
85  /// low-level interface. For cases in which it's desired to define
86  /// the container with a sparse set of child fields, the Builder class
87  /// is often more convenient and readable.
89  static HdContainerDataSourceHandle
91  const HdFloatDataSourceHandle &weight,
93  const HdVec3fArrayDataSourceHandle &normalOffsets
94  );
95 
96  /// \class UsdSkelImagingInbetweenShapeSchema::Builder
97  ///
98  /// Utility class for setting sparse sets of child data source fields to be
99  /// filled as arguments into BuildRetained. Because all setter methods
100  /// return a reference to the instance, this can be used in the "builder
101  /// pattern" form.
102  class Builder
103  {
104  public:
107  const HdFloatDataSourceHandle &weight);
113  const HdVec3fArrayDataSourceHandle &normalOffsets);
114 
115  /// Returns a container data source containing the members set thus far.
117  HdContainerDataSourceHandle Build();
118 
119  private:
120  HdFloatDataSourceHandle _weight;
122  HdVec3fArrayDataSourceHandle _normalOffsets;
123 
124  };
125 
126  /// @}
127 };
128 
130 
131 #endif
HdFloatDataSource::Handle HdFloatDataSourceHandle
#define USD_SKEL_IMAGING_INBETWEEN_SHAPE_SCHEMA_TOKENS
GLuint GLsizei const GLuint const GLintptr * offsets
Definition: glcorearb.h:2621
USDSKELIMAGING_API Builder & SetWeight(const HdFloatDataSourceHandle &weight)
USDSKELIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
USDSKELIMAGING_API HdVec3fArrayDataSourceHandle GetNormalOffsets() const
Corresponds to Usd attribute metadata.
UsdSkelImagingInbetweenShapeSchema(HdContainerDataSourceHandle container)
HdVec3fArrayDataSource::Handle HdVec3fArrayDataSourceHandle
USDSKELIMAGING_API HdVec3fArrayDataSourceHandle GetOffsets() const
Corresponds to Usd attribute metadata.
#define USDSKELIMAGING_API
Definition: api.h:23
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained(const HdFloatDataSourceHandle &weight, const HdVec3fArrayDataSourceHandle &offsets, const HdVec3fArrayDataSourceHandle &normalOffsets)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingInbetweenShapeSchemaTokens, USDSKELIMAGING_API, USD_SKEL_IMAGING_INBETWEEN_SHAPE_SCHEMA_TOKENS)
USDSKELIMAGING_API Builder & SetOffsets(const HdVec3fArrayDataSourceHandle &offsets)
USDSKELIMAGING_API Builder & SetNormalOffsets(const HdVec3fArrayDataSourceHandle &normalOffsets)
USDSKELIMAGING_API HdFloatDataSourceHandle GetWeight() const
Corresponds to Usd attribute metadata.