Loading...
Searching...
No Matches
revoluteJoint.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDPHYSICS_GENERATED_REVOLUTEJOINT_H
8#define USDPHYSICS_GENERATED_REVOLUTEJOINT_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdPhysics/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// PHYSICSREVOLUTEJOINT //
34// -------------------------------------------------------------------------- //
35
47{
48public:
52 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
53
58 explicit UsdPhysicsRevoluteJoint(const UsdPrim& prim=UsdPrim())
59 : UsdPhysicsJoint(prim)
60 {
61 }
62
66 explicit UsdPhysicsRevoluteJoint(const UsdSchemaBase& schemaObj)
67 : UsdPhysicsJoint(schemaObj)
68 {
69 }
70
72 USDPHYSICS_API
74
78 USDPHYSICS_API
79 static const TfTokenVector &
80 GetSchemaAttributeNames(bool includeInherited=true);
81
91 USDPHYSICS_API
93 Get(const UsdStagePtr &stage, const SdfPath &path);
94
117 USDPHYSICS_API
119 Define(const UsdStagePtr &stage, const SdfPath &path);
120
121protected:
125 USDPHYSICS_API
127
128private:
129 // needs to invoke _GetStaticTfType.
130 friend class UsdSchemaRegistry;
131 USDPHYSICS_API
132 static const TfType &_GetStaticTfType();
133
134 static bool _IsTypedSchema();
135
136 // override SchemaBase virtuals.
137 USDPHYSICS_API
138 const TfType &_GetTfType() const override;
139
140public:
141 // --------------------------------------------------------------------- //
142 // AXIS
143 // --------------------------------------------------------------------- //
153 USDPHYSICS_API
155
161 USDPHYSICS_API
162 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
163
164public:
165 // --------------------------------------------------------------------- //
166 // LOWERLIMIT
167 // --------------------------------------------------------------------- //
176 USDPHYSICS_API
178
184 USDPHYSICS_API
185 UsdAttribute CreateLowerLimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186
187public:
188 // --------------------------------------------------------------------- //
189 // UPPERLIMIT
190 // --------------------------------------------------------------------- //
199 USDPHYSICS_API
201
207 USDPHYSICS_API
208 UsdAttribute CreateUpperLimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209
210public:
211 // ===================================================================== //
212 // Feel free to add custom code below this line, it will be preserved by
213 // the code generator.
214 //
215 // Just remember to:
216 // - Close the class declaration with };
217 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
218 // - Close the include guard with #endif
219 // ===================================================================== //
220 // --(BEGIN CUSTOM CODE)--
221};
222
223PXR_NAMESPACE_CLOSE_SCOPE
224
225#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:78
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:183
A joint constrains the movement of rigid bodies.
Definition: joint.h:46
Predefined revolute joint type (rotation along revolute joint axis is permitted.)
Definition: revoluteJoint.h:47
USDPHYSICS_API UsdAttribute CreateUpperLimitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUpperLimitAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDPHYSICS_API UsdPhysicsRevoluteJoint Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDPHYSICS_API ~UsdPhysicsRevoluteJoint()
Destructor.
USDPHYSICS_API UsdAttribute CreateAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAxisAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdAttribute GetUpperLimitAttr() const
Upper limit.
USDPHYSICS_API UsdAttribute GetAxisAttr() const
Joint axis.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: revoluteJoint.h:52
UsdPhysicsRevoluteJoint(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsRevoluteJoint on UsdPrim prim .
Definition: revoluteJoint.h:58
static USDPHYSICS_API UsdPhysicsRevoluteJoint Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsRevoluteJoint holding the prim adhering to this schema at path on stage.
USDPHYSICS_API UsdAttribute CreateLowerLimitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLowerLimitAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdPhysicsRevoluteJoint(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsRevoluteJoint on the prim held by schemaObj .
Definition: revoluteJoint.h:66
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...
USDPHYSICS_API UsdAttribute GetLowerLimitAttr() const
Lower limit.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:152
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
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:440