driveAPI.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 USDPHYSICS_GENERATED_DRIVEAPI_H
25 #define USDPHYSICS_GENERATED_DRIVEAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdPhysics/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 // PHYSICSDRIVEAPI //
51 // -------------------------------------------------------------------------- //
52 
71 {
72 public:
77 
88  const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
89  : UsdAPISchemaBase(prim, /*instanceName*/ name)
90  { }
91 
97  const UsdSchemaBase& schemaObj, const TfToken &name)
98  : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
99  { }
100 
102  USDPHYSICS_API
103  virtual ~UsdPhysicsDriveAPI();
104 
108  USDPHYSICS_API
109  static const TfTokenVector &
110  GetSchemaAttributeNames(bool includeInherited=true);
111 
117  USDPHYSICS_API
118  static TfTokenVector
119  GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);
120 
122  TfToken GetName() const {
123  return _GetInstanceName();
124  }
125 
140  USDPHYSICS_API
141  static UsdPhysicsDriveAPI
142  Get(const UsdStagePtr &stage, const SdfPath &path);
143 
146  USDPHYSICS_API
147  static UsdPhysicsDriveAPI
148  Get(const UsdPrim &prim, const TfToken &name);
149 
152  USDPHYSICS_API
153  static bool
154  IsSchemaPropertyBaseName(const TfToken &baseName);
155 
159  USDPHYSICS_API
160  static bool
161  IsPhysicsDriveAPIPath(const SdfPath &path, TfToken *name);
162 
179  USDPHYSICS_API
180  static bool
181  CanApply(const UsdPrim &prim, const TfToken &name,
182  std::string *whyNot=nullptr);
183 
203  USDPHYSICS_API
204  static UsdPhysicsDriveAPI
205  Apply(const UsdPrim &prim, const TfToken &name);
206 
207 protected:
211  USDPHYSICS_API
212  UsdSchemaKind _GetSchemaKind() const override;
213 
214 private:
215  // needs to invoke _GetStaticTfType.
216  friend class UsdSchemaRegistry;
217  USDPHYSICS_API
218  static const TfType &_GetStaticTfType();
219 
220  static bool _IsTypedSchema();
221 
222  // override SchemaBase virtuals.
223  USDPHYSICS_API
224  const TfType &_GetTfType() const override;
225 
226 public:
227  // --------------------------------------------------------------------- //
228  // TYPE
229  // --------------------------------------------------------------------- //
240  USDPHYSICS_API
241  UsdAttribute GetTypeAttr() const;
242 
248  USDPHYSICS_API
249  UsdAttribute CreateTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
250 
251 public:
252  // --------------------------------------------------------------------- //
253  // MAXFORCE
254  // --------------------------------------------------------------------- //
266  USDPHYSICS_API
268 
274  USDPHYSICS_API
275  UsdAttribute CreateMaxForceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
276 
277 public:
278  // --------------------------------------------------------------------- //
279  // TARGETPOSITION
280  // --------------------------------------------------------------------- //
290  USDPHYSICS_API
292 
298  USDPHYSICS_API
299  UsdAttribute CreateTargetPositionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
300 
301 public:
302  // --------------------------------------------------------------------- //
303  // TARGETVELOCITY
304  // --------------------------------------------------------------------- //
314  USDPHYSICS_API
316 
322  USDPHYSICS_API
323  UsdAttribute CreateTargetVelocityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
324 
325 public:
326  // --------------------------------------------------------------------- //
327  // DAMPING
328  // --------------------------------------------------------------------- //
338  USDPHYSICS_API
340 
346  USDPHYSICS_API
347  UsdAttribute CreateDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
348 
349 public:
350  // --------------------------------------------------------------------- //
351  // STIFFNESS
352  // --------------------------------------------------------------------- //
362  USDPHYSICS_API
364 
370  USDPHYSICS_API
371  UsdAttribute CreateStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
372 
373 public:
374  // ===================================================================== //
375  // Feel free to add custom code below this line, it will be preserved by
376  // the code generator.
377  //
378  // Just remember to:
379  // - Close the class declaration with };
380  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
381  // - Close the include guard with #endif
382  // ===================================================================== //
383  // --(BEGIN CUSTOM CODE)--
384 };
385 
386 PXR_NAMESPACE_CLOSE_SCOPE
387 
388 #endif
static USDPHYSICS_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...
UsdPhysicsDriveAPI(const UsdSchemaBase &schemaObj, const TfToken &name)
Construct a UsdPhysicsDriveAPI on the prim held by schemaObj with name name.
Definition: driveAPI.h:96
USDPHYSICS_API UsdAttribute GetDampingAttr() const
Damping of the drive.
USDPHYSICS_API UsdAttribute CreateTargetPositionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTargetPositionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDPHYSICS_API UsdAttribute GetMaxForceAttr() const
Maximum force that can be applied to drive.
static USDPHYSICS_API bool IsPhysicsDriveAPIPath(const SdfPath &path, TfToken *name)
Checks if the given path path is of an API schema of type PhysicsDriveAPI.
USDPHYSICS_API UsdAttribute CreateTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDPHYSICS_API UsdAttribute CreateMaxForceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxForceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdAttribute CreateDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDampingAttr(), 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: driveAPI.h:76
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
USDPHYSICS_API UsdAttribute GetTargetVelocityAttr() const
Target value for velocity.
static USDPHYSICS_API UsdPhysicsDriveAPI Apply(const UsdPrim &prim, const TfToken &name)
Applies this multiple-apply API schema to the given prim along with the given instance name,...
static USDPHYSICS_API bool CanApply(const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
Returns true if this multiple-apply API schema can be applied, with the given instance name,...
The PhysicsDriveAPI when applied to any joint primitive will drive the joint towards a given target.
Definition: driveAPI.h:70
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:290
USDPHYSICS_API UsdAttribute GetTypeAttr() const
Drive spring is for the acceleration at the joint (rather than the force).
USDPHYSICS_API UsdAttribute CreateTargetVelocityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTargetVelocityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDPHYSICS_API ~UsdPhysicsDriveAPI()
Destructor.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
Multiple Apply API Schema.
TfToken GetName() const
Returns the name of this multiple-apply schema instance.
Definition: driveAPI.h:122
static USDPHYSICS_API UsdPhysicsDriveAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsDriveAPI holding the prim adhering to this schema at path on stage.
TfType represents a dynamic runtime type.
Definition: type.h:64
USDPHYSICS_API UsdAttribute GetStiffnessAttr() const
Stiffness of the drive.
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDPHYSICS_API UsdAttribute GetTargetPositionAttr() const
Target value for position.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
const TfToken & _GetInstanceName() const
Returns the instance name of the API schema object belonging to a multiple-apply API schema.
UsdPhysicsDriveAPI(const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
Construct a UsdPhysicsDriveAPI on UsdPrim prim with name name .
Definition: driveAPI.h:87
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsDriveAPI.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
USDPHYSICS_API UsdAttribute CreateStiffnessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetStiffnessAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...