All Classes Files Functions Variables Pages
physxMaterialAPI.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_PHYSXMATERIALAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXMATERIALAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "pxr/usd/usd/apiSchemaBase.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 // PHYSXMATERIALAPI //
51 // -------------------------------------------------------------------------- //
52 
62 class PhysxSchemaPhysxMaterialAPI : public UsdAPISchemaBase
63 {
64 public:
68  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
69 
74  explicit PhysxSchemaPhysxMaterialAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPhysxMaterialAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
128  PHYSXSCHEMA_API
129  static bool
130  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
131 
147  PHYSXSCHEMA_API
149  Apply(const UsdPrim &prim);
150 
151 protected:
155  PHYSXSCHEMA_API
156  UsdSchemaKind _GetSchemaKind() const override;
157 
158 private:
159  // needs to invoke _GetStaticTfType.
160  friend class UsdSchemaRegistry;
161  PHYSXSCHEMA_API
162  static const TfType &_GetStaticTfType();
163 
164  static bool _IsTypedSchema();
165 
166  // override SchemaBase virtuals.
167  PHYSXSCHEMA_API
168  const TfType &_GetTfType() const override;
169 
170 public:
171  // --------------------------------------------------------------------- //
172  // FRICTIONCOMBINEMODE
173  // --------------------------------------------------------------------- //
183  PHYSXSCHEMA_API
184  UsdAttribute GetFrictionCombineModeAttr() const;
185 
191  PHYSXSCHEMA_API
192  UsdAttribute CreateFrictionCombineModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
193 
194 public:
195  // --------------------------------------------------------------------- //
196  // RESTITUTIONCOMBINEMODE
197  // --------------------------------------------------------------------- //
207  PHYSXSCHEMA_API
208  UsdAttribute GetRestitutionCombineModeAttr() const;
209 
215  PHYSXSCHEMA_API
216  UsdAttribute CreateRestitutionCombineModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
217 
218 public:
219  // --------------------------------------------------------------------- //
220  // DAMPINGCOMBINEMODE
221  // --------------------------------------------------------------------- //
232  PHYSXSCHEMA_API
233  UsdAttribute GetDampingCombineModeAttr() const;
234 
240  PHYSXSCHEMA_API
241  UsdAttribute CreateDampingCombineModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
242 
243 public:
244  // --------------------------------------------------------------------- //
245  // IMPROVEPATCHFRICTION
246  // --------------------------------------------------------------------- //
259  PHYSXSCHEMA_API
260  UsdAttribute GetImprovePatchFrictionAttr() const;
261 
267  PHYSXSCHEMA_API
268  UsdAttribute CreateImprovePatchFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
269 
270 public:
271  // --------------------------------------------------------------------- //
272  // COMPLIANTCONTACTACCELERATIONSPRING
273  // --------------------------------------------------------------------- //
284  PHYSXSCHEMA_API
285  UsdAttribute GetCompliantContactAccelerationSpringAttr() const;
286 
292  PHYSXSCHEMA_API
293  UsdAttribute CreateCompliantContactAccelerationSpringAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // COMPLIANTCONTACTSTIFFNESS
298  // --------------------------------------------------------------------- //
311  PHYSXSCHEMA_API
312  UsdAttribute GetCompliantContactStiffnessAttr() const;
313 
319  PHYSXSCHEMA_API
320  UsdAttribute CreateCompliantContactStiffnessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
321 
322 public:
323  // --------------------------------------------------------------------- //
324  // COMPLIANTCONTACTDAMPING
325  // --------------------------------------------------------------------- //
338  PHYSXSCHEMA_API
339  UsdAttribute GetCompliantContactDampingAttr() const;
340 
346  PHYSXSCHEMA_API
347  UsdAttribute CreateCompliantContactDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
348 
349 public:
350  // ===================================================================== //
351  // Feel free to add custom code below this line, it will be preserved by
352  // the code generator.
353  //
354  // Just remember to:
355  // - Close the class declaration with };
356  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
357  // - Close the include guard with #endif
358  // ===================================================================== //
359  // --(BEGIN CUSTOM CODE)--
360 };
361 
362 PXR_NAMESPACE_CLOSE_SCOPE
363 
364 #endif
PHYSXSCHEMA_API UsdAttribute GetDampingCombineModeAttr() const
Determines the way in which two material properties will be combined to yield a damping coefficient f...
PHYSXSCHEMA_API UsdAttribute GetFrictionCombineModeAttr() const
Determines the way in which two material properties will be combined to yield a friction coefficient ...
PHYSXSCHEMA_API UsdAttribute CreateFrictionCombineModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFrictionCombineModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysX material extended parameters.
PHYSXSCHEMA_API UsdAttribute CreateImprovePatchFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetImprovePatchFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxMaterialAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxMaterialAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute CreateDampingCombineModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDampingCombineModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxMaterialAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxMaterialAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxMaterialAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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...
PHYSXSCHEMA_API UsdAttribute CreateCompliantContactDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCompliantContactDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxMaterialAPI()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetCompliantContactDampingAttr() const
Damping coefficient for a compliant contact model using implicit springs.
PHYSXSCHEMA_API UsdAttribute GetCompliantContactStiffnessAttr() const
Spring stiffness for a compliant contact model using implicit springs.
PHYSXSCHEMA_API UsdAttribute GetImprovePatchFrictionAttr() const
Deprecated.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PhysxSchemaPhysxMaterialAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxMaterialAPI on UsdPrim prim .
static PHYSXSCHEMA_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateCompliantContactAccelerationSpringAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCompliantContactAccelerationSpringAttr(), and also Usd_Create_Or_Get_Property for when to use ...
PHYSXSCHEMA_API UsdAttribute CreateCompliantContactStiffnessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCompliantContactStiffnessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cr...
PHYSXSCHEMA_API UsdAttribute GetRestitutionCombineModeAttr() const
Determines the way in which two material properties will be combined to yield a restitution coefficie...
PHYSXSCHEMA_API UsdAttribute GetCompliantContactAccelerationSpringAttr() const
If enabled, switches from force-based to acceleration-based compliant spring-damper contact effects...
PHYSXSCHEMA_API UsdAttribute CreateRestitutionCombineModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestitutionCombineModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...