Loading...
Searching...
No Matches
revoluteJoint.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_REVOLUTEJOINT_H
25#define USDPHYSICS_GENERATED_REVOLUTEJOINT_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// PHYSICSREVOLUTEJOINT //
51// -------------------------------------------------------------------------- //
52
64{
65public:
69 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
70
75 explicit UsdPhysicsRevoluteJoint(const UsdPrim& prim=UsdPrim())
76 : UsdPhysicsJoint(prim)
77 {
78 }
79
83 explicit UsdPhysicsRevoluteJoint(const UsdSchemaBase& schemaObj)
84 : UsdPhysicsJoint(schemaObj)
85 {
86 }
87
89 USDPHYSICS_API
91
95 USDPHYSICS_API
96 static const TfTokenVector &
97 GetSchemaAttributeNames(bool includeInherited=true);
98
108 USDPHYSICS_API
110 Get(const UsdStagePtr &stage, const SdfPath &path);
111
134 USDPHYSICS_API
136 Define(const UsdStagePtr &stage, const SdfPath &path);
137
138protected:
142 USDPHYSICS_API
144
145private:
146 // needs to invoke _GetStaticTfType.
147 friend class UsdSchemaRegistry;
148 USDPHYSICS_API
149 static const TfType &_GetStaticTfType();
150
151 static bool _IsTypedSchema();
152
153 // override SchemaBase virtuals.
154 USDPHYSICS_API
155 const TfType &_GetTfType() const override;
156
157public:
158 // --------------------------------------------------------------------- //
159 // AXIS
160 // --------------------------------------------------------------------- //
170 USDPHYSICS_API
172
178 USDPHYSICS_API
179 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180
181public:
182 // --------------------------------------------------------------------- //
183 // LOWERLIMIT
184 // --------------------------------------------------------------------- //
193 USDPHYSICS_API
195
201 USDPHYSICS_API
202 UsdAttribute CreateLowerLimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
203
204public:
205 // --------------------------------------------------------------------- //
206 // UPPERLIMIT
207 // --------------------------------------------------------------------- //
216 USDPHYSICS_API
218
224 USDPHYSICS_API
225 UsdAttribute CreateUpperLimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
226
227public:
228 // ===================================================================== //
229 // Feel free to add custom code below this line, it will be preserved by
230 // the code generator.
231 //
232 // Just remember to:
233 // - Close the class declaration with };
234 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
235 // - Close the include guard with #endif
236 // ===================================================================== //
237 // --(BEGIN CUSTOM CODE)--
238};
239
240PXR_NAMESPACE_CLOSE_SCOPE
241
242#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:291
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 revolute joint type (rotation along revolute joint axis is permitted.)
Definition: revoluteJoint.h:64
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:69
UsdPhysicsRevoluteJoint(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsRevoluteJoint on UsdPrim prim .
Definition: revoluteJoint.h:75
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:83
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: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:127
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:442