fixedJoint.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_FIXEDJOINT_H
25 #define USDPHYSICS_GENERATED_FIXEDJOINT_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"
34 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // PHYSICSFIXEDJOINT //
50 // -------------------------------------------------------------------------- //
51 
58 {
59 public:
64 
69  explicit UsdPhysicsFixedJoint(const UsdPrim& prim=UsdPrim())
70  : UsdPhysicsJoint(prim)
71  {
72  }
73 
77  explicit UsdPhysicsFixedJoint(const UsdSchemaBase& schemaObj)
78  : UsdPhysicsJoint(schemaObj)
79  {
80  }
81 
83  USDPHYSICS_API
84  virtual ~UsdPhysicsFixedJoint();
85 
89  USDPHYSICS_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDPHYSICS_API
103  static UsdPhysicsFixedJoint
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  USDPHYSICS_API
129  static UsdPhysicsFixedJoint
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  USDPHYSICS_API
137  UsdSchemaKind _GetSchemaKind() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDPHYSICS_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDPHYSICS_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // ===================================================================== //
153  // Feel free to add custom code below this line, it will be preserved by
154  // the code generator.
155  //
156  // Just remember to:
157  // - Close the class declaration with };
158  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
159  // - Close the include guard with #endif
160  // ===================================================================== //
161  // --(BEGIN CUSTOM CODE)--
162 };
163 
164 PXR_NAMESPACE_CLOSE_SCOPE
165 
166 #endif
virtual USDPHYSICS_API ~UsdPhysicsFixedJoint()
Destructor.
A joint constrains the movement of rigid bodies.
Definition: joint.h:62
UsdPhysicsFixedJoint(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsFixedJoint on UsdPrim prim .
Definition: fixedJoint.h:69
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
static USDPHYSICS_API UsdPhysicsFixedJoint Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdPhysicsFixedJoint(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsFixedJoint on the prim held by schemaObj .
Definition: fixedJoint.h:77
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: fixedJoint.h:63
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
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
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
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...
Predefined fixed joint type (All degrees of freedom are removed.)
Definition: fixedJoint.h:57
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
static USDPHYSICS_API UsdPhysicsFixedJoint Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsFixedJoint holding the prim adhering to this schema at path on stage.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...