All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
sphericalJoint.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_SPHERICALJOINT_H
8#define USDPHYSICS_GENERATED_SPHERICALJOINT_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// PHYSICSSPHERICALJOINT //
34// -------------------------------------------------------------------------- //
35
49{
50public:
54 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
55
61 : UsdPhysicsJoint(prim)
62 {
63 }
64
68 explicit UsdPhysicsSphericalJoint(const UsdSchemaBase& schemaObj)
69 : UsdPhysicsJoint(schemaObj)
70 {
71 }
72
74 USDPHYSICS_API
76
80 USDPHYSICS_API
81 static const TfTokenVector &
82 GetSchemaAttributeNames(bool includeInherited=true);
83
93 USDPHYSICS_API
95 Get(const UsdStagePtr &stage, const SdfPath &path);
96
119 USDPHYSICS_API
121 Define(const UsdStagePtr &stage, const SdfPath &path);
122
123protected:
127 USDPHYSICS_API
129
130private:
131 // needs to invoke _GetStaticTfType.
132 friend class UsdSchemaRegistry;
133 USDPHYSICS_API
134 static const TfType &_GetStaticTfType();
135
136 static bool _IsTypedSchema();
137
138 // override SchemaBase virtuals.
139 USDPHYSICS_API
140 const TfType &_GetTfType() const override;
141
142public:
143 // --------------------------------------------------------------------- //
144 // AXIS
145 // --------------------------------------------------------------------- //
155 USDPHYSICS_API
157
163 USDPHYSICS_API
164 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165
166public:
167 // --------------------------------------------------------------------- //
168 // CONEANGLE0LIMIT
169 // --------------------------------------------------------------------- //
179 USDPHYSICS_API
181
187 USDPHYSICS_API
188 UsdAttribute CreateConeAngle0LimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189
190public:
191 // --------------------------------------------------------------------- //
192 // CONEANGLE1LIMIT
193 // --------------------------------------------------------------------- //
203 USDPHYSICS_API
205
211 USDPHYSICS_API
212 UsdAttribute CreateConeAngle1LimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213
214public:
215 // ===================================================================== //
216 // Feel free to add custom code below this line, it will be preserved by
217 // the code generator.
218 //
219 // Just remember to:
220 // - Close the class declaration with };
221 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
222 // - Close the include guard with #endif
223 // ===================================================================== //
224 // --(BEGIN CUSTOM CODE)--
225};
226
227PXR_NAMESPACE_CLOSE_SCOPE
228
229#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
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:160
A joint constrains the movement of rigid bodies.
Definition: joint.h:46
Predefined spherical joint type (Removes linear degrees of freedom, cone limit may restrict the motio...
USDPHYSICS_API UsdAttribute CreateConeAngle1LimitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetConeAngle1LimitAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDPHYSICS_API UsdPhysicsSphericalJoint Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsSphericalJoint holding the prim adhering to this schema at path on stage.
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.
UsdPhysicsSphericalJoint(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsSphericalJoint on UsdPrim prim .
USDPHYSICS_API UsdAttribute GetAxisAttr() const
Cone limit axis.
UsdPhysicsSphericalJoint(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsSphericalJoint on the prim held by schemaObj .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
USDPHYSICS_API UsdAttribute CreateConeAngle0LimitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetConeAngle0LimitAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDPHYSICS_API UsdPhysicsSphericalJoint 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 ~UsdPhysicsSphericalJoint()
Destructor.
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 GetConeAngle1LimitAttr() const
Cone limit from the primary joint axis in the local0 frame toward the second to next axis.
USDPHYSICS_API UsdAttribute GetConeAngle0LimitAttr() const
Cone limit from the primary joint axis in the local0 frame toward the next axis.
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:147
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