All Classes Files Functions Variables Pages
physxPhysicsGearJoint.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 PHYSXSCHEMA_GENERATED_PHYSXPHYSICSGEARJOINT_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPHYSICSGEARJOINT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "usdPhysics/joint.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include ".//tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PHYSXPHYSICSGEARJOINT //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
64 
69  explicit PhysxSchemaPhysxPhysicsGearJoint(const UsdPrim& prim=UsdPrim())
70  : UsdPhysicsJoint(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxPhysicsGearJoint(const UsdSchemaBase& schemaObj)
78  : UsdPhysicsJoint(schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  PHYSXSCHEMA_API
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  PHYSXSCHEMA_API
137  UsdSchemaType _GetSchemaType() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  PHYSXSCHEMA_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  PHYSXSCHEMA_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // GEARRATIO
154  // --------------------------------------------------------------------- //
164  PHYSXSCHEMA_API
165  UsdAttribute GetGearRatioAttr() const;
166 
172  PHYSXSCHEMA_API
173  UsdAttribute CreateGearRatioAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // HINGE0
178  // --------------------------------------------------------------------- //
181  PHYSXSCHEMA_API
182  UsdRelationship GetHinge0Rel() const;
183 
186  PHYSXSCHEMA_API
187  UsdRelationship CreateHinge0Rel() const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // HINGE1
192  // --------------------------------------------------------------------- //
195  PHYSXSCHEMA_API
196  UsdRelationship GetHinge1Rel() const;
197 
200  PHYSXSCHEMA_API
201  UsdRelationship CreateHinge1Rel() const;
202 
203 public:
204  // ===================================================================== //
205  // Feel free to add custom code below this line, it will be preserved by
206  // the code generator.
207  //
208  // Just remember to:
209  // - Close the class declaration with };
210  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
211  // - Close the include guard with #endif
212  // ===================================================================== //
213  // --(BEGIN CUSTOM CODE)--
214 };
215 
216 PXR_NAMESPACE_CLOSE_SCOPE
217 
218 #endif
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
A joint constrains the movement of rigid bodies.
Definition: joint.h:62
PHYSXSCHEMA_API UsdRelationship GetHinge1Rel() const
Relationship to second revolute joint.
PHYSXSCHEMA_API UsdRelationship CreateHinge1Rel() const
See GetHinge1Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute GetGearRatioAttr() const
Gear ratio Range: (-inf, inf) Units: dimensionless.
PHYSXSCHEMA_API UsdRelationship CreateHinge0Rel() const
See GetHinge0Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PhysxSchemaPhysxPhysicsGearJoint(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxPhysicsGearJoint on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateGearRatioAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGearRatioAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxPhysicsGearJoint()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsGearJoint Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
PHYSXSCHEMA_API UsdRelationship GetHinge0Rel() const
Relationship to first revolute joint.
static PHYSXSCHEMA_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 gear joint type.
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsGearJoint Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxPhysicsGearJoint holding the prim adhering to this schema at path on stage...
PhysxSchemaPhysxPhysicsGearJoint(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxPhysicsGearJoint on the prim held by schemaObj .