All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
blendShape.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 USDSKEL_GENERATED_BLENDSHAPE_H
25 #define USDSKEL_GENERATED_BLENDSHAPE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdSkel/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdSkel/tokens.h"
35 
36 #include "pxr/base/tf/span.h"
37 #include "pxr/usd/usdSkel/inbetweenShape.h"
38 
39 #include "pxr/base/vt/value.h"
40 
41 #include "pxr/base/gf/vec3d.h"
42 #include "pxr/base/gf/vec3f.h"
43 #include "pxr/base/gf/matrix4d.h"
44 
45 #include "pxr/base/tf/token.h"
46 #include "pxr/base/tf/type.h"
47 
48 PXR_NAMESPACE_OPEN_SCOPE
49 
50 class SdfAssetPath;
51 
52 // -------------------------------------------------------------------------- //
53 // BLENDSHAPE //
54 // -------------------------------------------------------------------------- //
55 
66 {
67 public:
72 
77  explicit UsdSkelBlendShape(const UsdPrim& prim=UsdPrim())
78  : UsdTyped(prim)
79  {
80  }
81 
85  explicit UsdSkelBlendShape(const UsdSchemaBase& schemaObj)
86  : UsdTyped(schemaObj)
87  {
88  }
89 
91  USDSKEL_API
92  virtual ~UsdSkelBlendShape();
93 
97  USDSKEL_API
98  static const TfTokenVector &
99  GetSchemaAttributeNames(bool includeInherited=true);
100 
110  USDSKEL_API
111  static UsdSkelBlendShape
112  Get(const UsdStagePtr &stage, const SdfPath &path);
113 
136  USDSKEL_API
137  static UsdSkelBlendShape
138  Define(const UsdStagePtr &stage, const SdfPath &path);
139 
140 protected:
144  USDSKEL_API
145  UsdSchemaType _GetSchemaType() const override;
146 
147 private:
148  // needs to invoke _GetStaticTfType.
149  friend class UsdSchemaRegistry;
150  USDSKEL_API
151  static const TfType &_GetStaticTfType();
152 
153  static bool _IsTypedSchema();
154 
155  // override SchemaBase virtuals.
156  USDSKEL_API
157  const TfType &_GetTfType() const override;
158 
159 public:
160  // --------------------------------------------------------------------- //
161  // OFFSETS
162  // --------------------------------------------------------------------- //
170  USDSKEL_API
172 
178  USDSKEL_API
179  UsdAttribute CreateOffsetsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180 
181 public:
182  // --------------------------------------------------------------------- //
183  // NORMALOFFSETS
184  // --------------------------------------------------------------------- //
192  USDSKEL_API
194 
200  USDSKEL_API
201  UsdAttribute CreateNormalOffsetsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
202 
203 public:
204  // --------------------------------------------------------------------- //
205  // POINTINDICES
206  // --------------------------------------------------------------------- //
216  USDSKEL_API
218 
224  USDSKEL_API
225  UsdAttribute CreatePointIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
226 
227 public:
228  // ===================================================================== //
229  // Feel free to add custom code below this line, it will be preserved by
230  // the code generator.
231  //
232  // Just remember to:
233  // - Close the class declaration with };
234  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
235  // - Close the include guard with #endif
236  // ===================================================================== //
237  // --(BEGIN CUSTOM CODE)--
238 
253  USDSKEL_API
254  UsdSkelInbetweenShape CreateInbetween(const TfToken& name) const;
255 
265  USDSKEL_API
266  UsdSkelInbetweenShape GetInbetween(const TfToken& name) const;
267 
273  USDSKEL_API
274  bool HasInbetween(const TfToken& name) const;
275 
278  USDSKEL_API
279  std::vector<UsdSkelInbetweenShape> GetInbetweens() const;
280 
283  USDSKEL_API
284  std::vector<UsdSkelInbetweenShape> GetAuthoredInbetweens() const;
285 
291  USDSKEL_API
292  static bool ValidatePointIndices(TfSpan<const int> indices,
293  size_t numPoints,
294  std::string* reason=nullptr);
295 
296 private:
297  std::vector<UsdSkelInbetweenShape>
298  _MakeInbetweens(const std::vector<UsdProperty>& props) const;
299 };
300 
301 PXR_NAMESPACE_CLOSE_SCOPE
302 
303 #endif
Describes a target blend shape, possibly containing inbetween shapes.
Definition: blendShape.h:65
static USDSKEL_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
USDSKEL_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDSKEL_API std::vector< UsdSkelInbetweenShape > GetInbetweens() const
Return valid UsdSkelInbetweenShape objects for all defined Inbetweens on this prim.
UsdSkelBlendShape(const UsdSchemaBase &schemaObj)
Construct a UsdSkelBlendShape on the prim held by schemaObj .
Definition: blendShape.h:85
USDSKEL_API bool HasInbetween(const TfToken &name) const
Return true if there is a defined Inbetween named name on this prim.
USDSKEL_API UsdAttribute CreateOffsetsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdSkelBlendShape(const UsdPrim &prim=UsdPrim())
Construct a UsdSkelBlendShape on UsdPrim prim .
Definition: blendShape.h:77
USDSKEL_API UsdAttribute GetPointIndicesAttr() const
Optional property.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDSKEL_API UsdAttribute CreateNormalOffsetsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetNormalOffsetsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDSKEL_API UsdSkelInbetweenShape CreateInbetween(const TfToken &name) const
Author scene description to create an attribute on this prim that will be recognized as an Inbetween ...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
static USDSKEL_API UsdSkelBlendShape Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDSKEL_API UsdAttribute GetNormalOffsetsAttr() const
Required property.
Represents a range of contiguous elements.
Definition: span.h:87
USDSKEL_API std::vector< UsdSkelInbetweenShape > GetAuthoredInbetweens() const
Like GetInbetweens(), but exclude inbetwens that have no authored scene / description.
USDSKEL_API UsdAttribute CreatePointIndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPointIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a &quot;Prim&quot; as ...
Definition: prim.h:131
The base class for all typed schemas (those that can impart a typeName to a UsdPrim), and therefore the base class for all instantiable and &quot;IsA&quot; schemas.
Definition: typed.h:47
static USDSKEL_API UsdSkelBlendShape Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdSkelBlendShape holding the prim adhering to this schema at path on stage.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
static USDSKEL_API bool ValidatePointIndices(TfSpan< const int > indices, size_t numPoints, std::string *reason=nullptr)
Validates a set of point indices for a given point count.
USDSKEL_API UsdSkelInbetweenShape GetInbetween(const TfToken &name) const
Return the Inbetween corresponding to the attribute named name, which will be valid if an Inbetween a...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
virtual USDSKEL_API ~UsdSkelBlendShape()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: blendShape.h:71
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Schema wrapper for UsdAttribute for authoring and introspecting attributes that serve as inbetween sh...
USDSKEL_API UsdAttribute GetOffsetsAttr() const
Required property.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182