Loading...
Searching...
No Matches
sphericalJoint.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_SPHERICALJOINT_H
25#define USDPHYSICS_GENERATED_SPHERICALJOINT_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"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// PHYSICSSPHERICALJOINT //
51// -------------------------------------------------------------------------- //
52
66{
67public:
71 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
72
78 : UsdPhysicsJoint(prim)
79 {
80 }
81
85 explicit UsdPhysicsSphericalJoint(const UsdSchemaBase& schemaObj)
86 : UsdPhysicsJoint(schemaObj)
87 {
88 }
89
91 USDPHYSICS_API
93
97 USDPHYSICS_API
98 static const TfTokenVector &
99 GetSchemaAttributeNames(bool includeInherited=true);
100
110 USDPHYSICS_API
112 Get(const UsdStagePtr &stage, const SdfPath &path);
113
136 USDPHYSICS_API
138 Define(const UsdStagePtr &stage, const SdfPath &path);
139
140protected:
144 USDPHYSICS_API
146
147private:
148 // needs to invoke _GetStaticTfType.
149 friend class UsdSchemaRegistry;
150 USDPHYSICS_API
151 static const TfType &_GetStaticTfType();
152
153 static bool _IsTypedSchema();
154
155 // override SchemaBase virtuals.
156 USDPHYSICS_API
157 const TfType &_GetTfType() const override;
158
159public:
160 // --------------------------------------------------------------------- //
161 // AXIS
162 // --------------------------------------------------------------------- //
172 USDPHYSICS_API
174
180 USDPHYSICS_API
181 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182
183public:
184 // --------------------------------------------------------------------- //
185 // CONEANGLE0LIMIT
186 // --------------------------------------------------------------------- //
196 USDPHYSICS_API
198
204 USDPHYSICS_API
205 UsdAttribute CreateConeAngle0LimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
206
207public:
208 // --------------------------------------------------------------------- //
209 // CONEANGLE1LIMIT
210 // --------------------------------------------------------------------- //
220 USDPHYSICS_API
222
228 USDPHYSICS_API
229 UsdAttribute CreateConeAngle1LimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
230
231public:
232 // ===================================================================== //
233 // Feel free to add custom code below this line, it will be preserved by
234 // the code generator.
235 //
236 // Just remember to:
237 // - Close the class declaration with };
238 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
239 // - Close the include guard with #endif
240 // ===================================================================== //
241 // --(BEGIN CUSTOM CODE)--
242};
243
244PXR_NAMESPACE_CLOSE_SCOPE
245
246#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
A joint constrains the movement of rigid bodies.
Definition: joint.h:63
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:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
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:164
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
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:457