Loading...
Searching...
No Matches
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"
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"
44
45#include "pxr/base/tf/token.h"
46#include "pxr/base/tf/type.h"
47
48PXR_NAMESPACE_OPEN_SCOPE
49
50class SdfAssetPath;
51
52// -------------------------------------------------------------------------- //
53// BLENDSHAPE //
54// -------------------------------------------------------------------------- //
55
66{
67public:
71 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
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
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
140protected:
144 USDSKEL_API
146
147private:
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
159public:
160 // --------------------------------------------------------------------- //
161 // OFFSETS
162 // --------------------------------------------------------------------- //
172 USDSKEL_API
174
180 USDSKEL_API
181 UsdAttribute CreateOffsetsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182
183public:
184 // --------------------------------------------------------------------- //
185 // NORMALOFFSETS
186 // --------------------------------------------------------------------- //
196 USDSKEL_API
198
204 USDSKEL_API
205 UsdAttribute CreateNormalOffsetsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
206
207public:
208 // --------------------------------------------------------------------- //
209 // POINTINDICES
210 // --------------------------------------------------------------------- //
222 USDSKEL_API
224
230 USDSKEL_API
231 UsdAttribute CreatePointIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
232
233public:
234 // ===================================================================== //
235 // Feel free to add custom code below this line, it will be preserved by
236 // the code generator.
237 //
238 // Just remember to:
239 // - Close the class declaration with };
240 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
241 // - Close the include guard with #endif
242 // ===================================================================== //
243 // --(BEGIN CUSTOM CODE)--
244
259 USDSKEL_API
261
271 USDSKEL_API
273
279 USDSKEL_API
280 bool HasInbetween(const TfToken& name) const;
281
284 USDSKEL_API
285 std::vector<UsdSkelInbetweenShape> GetInbetweens() const;
286
289 USDSKEL_API
290 std::vector<UsdSkelInbetweenShape> GetAuthoredInbetweens() const;
291
297 USDSKEL_API
299 size_t numPoints,
300 std::string* reason=nullptr);
301
302private:
303 std::vector<UsdSkelInbetweenShape>
304 _MakeInbetweens(const std::vector<UsdProperty>& props) const;
305};
306
307PXR_NAMESPACE_CLOSE_SCOPE
308
309#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Represents a range of contiguous elements.
Definition: span.h:88
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Describes a target blend shape, possibly containing inbetween shapes.
Definition: blendShape.h:66
USDSKEL_API UsdAttribute GetOffsetsAttr() const
Required property.
USDSKEL_API UsdAttribute GetNormalOffsetsAttr() const
Required property.
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...
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.
UsdSkelBlendShape(const UsdPrim &prim=UsdPrim())
Construct a UsdSkelBlendShape on UsdPrim prim .
Definition: blendShape.h:77
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 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.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: blendShape.h:71
USDSKEL_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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.
USDSKEL_API std::vector< UsdSkelInbetweenShape > GetInbetweens() const
Return valid UsdSkelInbetweenShape objects for all defined Inbetweens on this prim.
USDSKEL_API std::vector< UsdSkelInbetweenShape > GetAuthoredInbetweens() const
Like GetInbetweens(), but exclude inbetwens that have no authored scene / description.
virtual USDSKEL_API ~UsdSkelBlendShape()
Destructor.
USDSKEL_API UsdAttribute GetPointIndicesAttr() const
Optional property.
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 ...
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...
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.
UsdSkelBlendShape(const UsdSchemaBase &schemaObj)
Construct a UsdSkelBlendShape on the prim held by schemaObj .
Definition: blendShape.h:85
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 bool HasInbetween(const TfToken &name) const
Return true if there is a defined Inbetween named name on this prim.
Schema wrapper for UsdAttribute for authoring and introspecting attributes that serve as inbetween sh...
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition: typed.h:62
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457