All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
motionAPI.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 USDGEOM_GENERATED_MOTIONAPI_H
25 #define USDGEOM_GENERATED_MOTIONAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdGeom/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // MOTIONAPI //
51 // -------------------------------------------------------------------------- //
52 
65 {
66 public:
71 
76  explicit UsdGeomMotionAPI(const UsdPrim& prim=UsdPrim())
77  : UsdAPISchemaBase(prim)
78  {
79  }
80 
84  explicit UsdGeomMotionAPI(const UsdSchemaBase& schemaObj)
85  : UsdAPISchemaBase(schemaObj)
86  {
87  }
88 
90  USDGEOM_API
91  virtual ~UsdGeomMotionAPI();
92 
96  USDGEOM_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
109  USDGEOM_API
110  static UsdGeomMotionAPI
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
113 
130  USDGEOM_API
131  static bool
132  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
133 
149  USDGEOM_API
150  static UsdGeomMotionAPI
151  Apply(const UsdPrim &prim);
152 
153 protected:
157  USDGEOM_API
158  UsdSchemaKind _GetSchemaKind() const override;
159 
160 private:
161  // needs to invoke _GetStaticTfType.
162  friend class UsdSchemaRegistry;
163  USDGEOM_API
164  static const TfType &_GetStaticTfType();
165 
166  static bool _IsTypedSchema();
167 
168  // override SchemaBase virtuals.
169  USDGEOM_API
170  const TfType &_GetTfType() const override;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // VELOCITYSCALE
175  // --------------------------------------------------------------------- //
194  USDGEOM_API
196 
202  USDGEOM_API
203  UsdAttribute CreateVelocityScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204 
205 public:
206  // ===================================================================== //
207  // Feel free to add custom code below this line, it will be preserved by
208  // the code generator.
209  //
210  // Just remember to:
211  // - Close the class declaration with };
212  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
213  // - Close the include guard with #endif
214  // ===================================================================== //
215  // --(BEGIN CUSTOM CODE)--
216 
227  USDGEOM_API
229 
230 };
231 
232 PXR_NAMESPACE_CLOSE_SCOPE
233 
234 #endif
virtual USDGEOM_API ~UsdGeomMotionAPI()
Destructor.
static USDGEOM_API UsdGeomMotionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDGEOM_API UsdAttribute GetVelocityScaleAttr() const
VelocityScale is an inherited float attribute that velocity-based schemas (e.g.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
static USDGEOM_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Single Apply API schema.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
UsdGeomMotionAPI encodes data that can live on any prim that may affect computations involving: ...
Definition: motionAPI.h:64
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: motionAPI.h:70
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
static USDGEOM_API UsdGeomMotionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomMotionAPI holding the prim adhering to this schema at path on stage.
static constexpr UsdTimeCode Default()
Produce a UsdTimeCode representing the sentinel value for &#39;default&#39;.
Definition: timeCode.h:113
UsdGeomMotionAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomMotionAPI on UsdPrim prim .
Definition: motionAPI.h:76
TfType represents a dynamic runtime type.
Definition: type.h:64
USDGEOM_API float ComputeVelocityScale(UsdTimeCode time=UsdTimeCode::Default()) const
Compute the inherited value of velocityScale at time, i.e.
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
static USDGEOM_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...
UsdGeomMotionAPI(const UsdSchemaBase &schemaObj)
Construct a UsdGeomMotionAPI on the prim held by schemaObj .
Definition: motionAPI.h:84
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
USDGEOM_API UsdAttribute CreateVelocityScaleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVelocityScaleAttr(), and also Create vs Get Property Methods for when to use Get vs Create...