All Classes Files Functions Variables Pages
physxPhysicsJointInstancer.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_PHYSXPHYSICSJOINTINSTANCER_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPHYSICSJOINTINSTANCER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.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 // PHYSXPHYSICSJOINTINSTANCER //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
63  static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
64 
69  explicit PhysxSchemaPhysxPhysicsJointInstancer(const UsdPrim& prim=UsdPrim())
71  {
72  }
73 
77  explicit PhysxSchemaPhysxPhysicsJointInstancer(const UsdSchemaBase& 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  UsdSchemaKind _GetSchemaKind() 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  // PHYSICSBODY0INDICES
154  // --------------------------------------------------------------------- //
164  PHYSXSCHEMA_API
165  UsdAttribute GetPhysicsBody0IndicesAttr() const;
166 
172  PHYSXSCHEMA_API
173  UsdAttribute CreatePhysicsBody0IndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // PHYSICSBODY1INDICES
178  // --------------------------------------------------------------------- //
188  PHYSXSCHEMA_API
189  UsdAttribute GetPhysicsBody1IndicesAttr() const;
190 
196  PHYSXSCHEMA_API
197  UsdAttribute CreatePhysicsBody1IndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
198 
199 public:
200  // --------------------------------------------------------------------- //
201  // PHYSICSLOCALPOS0S
202  // --------------------------------------------------------------------- //
211  PHYSXSCHEMA_API
212  UsdAttribute GetPhysicsLocalPos0sAttr() const;
213 
219  PHYSXSCHEMA_API
220  UsdAttribute CreatePhysicsLocalPos0sAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
221 
222 public:
223  // --------------------------------------------------------------------- //
224  // PHYSICSLOCALROT0S
225  // --------------------------------------------------------------------- //
234  PHYSXSCHEMA_API
235  UsdAttribute GetPhysicsLocalRot0sAttr() const;
236 
242  PHYSXSCHEMA_API
243  UsdAttribute CreatePhysicsLocalRot0sAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
244 
245 public:
246  // --------------------------------------------------------------------- //
247  // PHYSICSLOCALPOS1S
248  // --------------------------------------------------------------------- //
257  PHYSXSCHEMA_API
258  UsdAttribute GetPhysicsLocalPos1sAttr() const;
259 
265  PHYSXSCHEMA_API
266  UsdAttribute CreatePhysicsLocalPos1sAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
267 
268 public:
269  // --------------------------------------------------------------------- //
270  // PHYSICSLOCALROT1S
271  // --------------------------------------------------------------------- //
280  PHYSXSCHEMA_API
281  UsdAttribute GetPhysicsLocalRot1sAttr() const;
282 
288  PHYSXSCHEMA_API
289  UsdAttribute CreatePhysicsLocalRot1sAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
290 
291 public:
292  // --------------------------------------------------------------------- //
293  // PHYSICSBODY0S
294  // --------------------------------------------------------------------- //
300  PHYSXSCHEMA_API
301  UsdRelationship GetPhysicsBody0sRel() const;
302 
305  PHYSXSCHEMA_API
306  UsdRelationship CreatePhysicsBody0sRel() const;
307 
308 public:
309  // --------------------------------------------------------------------- //
310  // PHYSICSBODY1S
311  // --------------------------------------------------------------------- //
317  PHYSXSCHEMA_API
318  UsdRelationship GetPhysicsBody1sRel() const;
319 
322  PHYSXSCHEMA_API
323  UsdRelationship CreatePhysicsBody1sRel() const;
324 
325 public:
326  // ===================================================================== //
327  // Feel free to add custom code below this line, it will be preserved by
328  // the code generator.
329  //
330  // Just remember to:
331  // - Close the class declaration with };
332  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
333  // - Close the include guard with #endif
334  // ===================================================================== //
335  // --(BEGIN CUSTOM CODE)--
336 };
337 
338 PXR_NAMESPACE_CLOSE_SCOPE
339 
340 #endif
PHYSXSCHEMA_API UsdRelationship GetPhysicsBody1sRel() const
Required property.
Physics joint instancer, the prototypes are expected to be UsdPhysicsJoint prim types.
PHYSXSCHEMA_API UsdAttribute CreatePhysicsLocalRot0sAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsLocalRot0sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship CreatePhysicsBody0sRel() const
See GetPhysicsBody0sRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetPhysicsLocalRot1sAttr() const
Required property.
PhysxSchemaPhysxPhysicsJointInstancer(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxPhysicsJointInstancer on the prim held by schemaObj . ...
PHYSXSCHEMA_API UsdAttribute CreatePhysicsBody1IndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsBody1IndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship CreatePhysicsBody1sRel() const
See GetPhysicsBody1sRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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...
PhysxSchemaPhysxPhysicsJointInstancer(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxPhysicsJointInstancer on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreatePhysicsLocalPos1sAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsLocalPos1sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsJointInstancer 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 UsdAttribute GetPhysicsLocalPos1sAttr() const
Required property.
PHYSXSCHEMA_API UsdAttribute CreatePhysicsBody0IndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsBody0IndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetPhysicsBody0IndicesAttr() const
Optional property.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreatePhysicsLocalPos0sAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsLocalPos0sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreatePhysicsLocalRot1sAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPhysicsLocalRot1sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetPhysicsBody1IndicesAttr() const
Optional property.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxPhysicsJointInstancer()
Destructor.
PHYSXSCHEMA_API UsdRelationship GetPhysicsBody0sRel() const
Required property.
Core class for instancing physics prims.
PHYSXSCHEMA_API UsdAttribute GetPhysicsLocalPos0sAttr() const
Required property.
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsJointInstancer Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxPhysicsJointInstancer holding the prim adhering to this schema at path on st...
PHYSXSCHEMA_API UsdAttribute GetPhysicsLocalRot0sAttr() const
Required property.