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"
31 #include "pxr/usd/usd/apiSchemaBase.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 
126  USDGEOM_API
127  static UsdGeomMotionAPI
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  USDGEOM_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  USDGEOM_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  USDGEOM_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // VELOCITYSCALE
152  // --------------------------------------------------------------------- //
170  USDGEOM_API
172 
178  USDGEOM_API
179  UsdAttribute CreateVelocityScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180 
181 public:
182  // ===================================================================== //
183  // Feel free to add custom code below this line, it will be preserved by
184  // the code generator.
185  //
186  // Just remember to:
187  // - Close the class declaration with };
188  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
189  // - Close the include guard with #endif
190  // ===================================================================== //
191  // --(BEGIN CUSTOM CODE)--
192 
203  USDGEOM_API
205 
206 };
207 
208 PXR_NAMESPACE_CLOSE_SCOPE
209 
210 #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.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: motionAPI.h:70
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
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type 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
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 "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Single Apply API schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
UsdGeomMotionAPI encodes data that can live on any prim that may affect computations involving: ...
Definition: motionAPI.h:64
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
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:70
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 prim and property definition information for registered Us...
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:182
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...