All Classes Files Functions Variables Pages
physxDeformableSurfaceMaterialAPI.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_PHYSXDEFORMABLESURFACEMATERIALAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXDEFORMABLESURFACEMATERIALAPI_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 // PHYSXDEFORMABLESURFACEMATERIALAPI //
51 // -------------------------------------------------------------------------- //
52 
58 class PhysxSchemaPhysxDeformableSurfaceMaterialAPI : public UsdAPISchemaBase
59 {
60 public:
64  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
65 
70  explicit PhysxSchemaPhysxDeformableSurfaceMaterialAPI(const UsdPrim& prim=UsdPrim())
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
78  explicit PhysxSchemaPhysxDeformableSurfaceMaterialAPI(const UsdSchemaBase& schemaObj)
79  : UsdAPISchemaBase(schemaObj)
80  {
81  }
82 
84  PHYSXSCHEMA_API
86 
90  PHYSXSCHEMA_API
91  static const TfTokenVector &
92  GetSchemaAttributeNames(bool includeInherited=true);
93 
103  PHYSXSCHEMA_API
105  Get(const UsdStagePtr &stage, const SdfPath &path);
106 
107 
122  PHYSXSCHEMA_API
124  Apply(const UsdPrim &prim);
125 
126 protected:
130  PHYSXSCHEMA_API
131  UsdSchemaType _GetSchemaType() const override;
132 
133 private:
134  // needs to invoke _GetStaticTfType.
135  friend class UsdSchemaRegistry;
136  PHYSXSCHEMA_API
137  static const TfType &_GetStaticTfType();
138 
139  static bool _IsTypedSchema();
140 
141  // override SchemaBase virtuals.
142  PHYSXSCHEMA_API
143  const TfType &_GetTfType() const override;
144 
145 public:
146  // --------------------------------------------------------------------- //
147  // DENSITY
148  // --------------------------------------------------------------------- //
158  PHYSXSCHEMA_API
159  UsdAttribute GetDensityAttr() const;
160 
166  PHYSXSCHEMA_API
167  UsdAttribute CreateDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // ELASTICITYDAMPING
172  // --------------------------------------------------------------------- //
182  PHYSXSCHEMA_API
183  UsdAttribute GetElasticityDampingAttr() const;
184 
190  PHYSXSCHEMA_API
191  UsdAttribute CreateElasticityDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192 
193 public:
194  // --------------------------------------------------------------------- //
195  // DYNAMICFRICTION
196  // --------------------------------------------------------------------- //
206  PHYSXSCHEMA_API
207  UsdAttribute GetDynamicFrictionAttr() const;
208 
214  PHYSXSCHEMA_API
215  UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
216 
217 public:
218  // --------------------------------------------------------------------- //
219  // YOUNGSMODULUS
220  // --------------------------------------------------------------------- //
230  PHYSXSCHEMA_API
231  UsdAttribute GetYoungsModulusAttr() const;
232 
238  PHYSXSCHEMA_API
239  UsdAttribute CreateYoungsModulusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
240 
241 public:
242  // --------------------------------------------------------------------- //
243  // POISSONSRATIO
244  // --------------------------------------------------------------------- //
254  PHYSXSCHEMA_API
255  UsdAttribute GetPoissonsRatioAttr() const;
256 
262  PHYSXSCHEMA_API
263  UsdAttribute CreatePoissonsRatioAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
264 
265 public:
266  // --------------------------------------------------------------------- //
267  // THICKNESS
268  // --------------------------------------------------------------------- //
278  PHYSXSCHEMA_API
279  UsdAttribute GetThicknessAttr() const;
280 
286  PHYSXSCHEMA_API
287  UsdAttribute CreateThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
288 
289 public:
290  // --------------------------------------------------------------------- //
291  // BENDINGDAMPING
292  // --------------------------------------------------------------------- //
302  PHYSXSCHEMA_API
303  UsdAttribute GetBendingDampingAttr() const;
304 
310  PHYSXSCHEMA_API
311  UsdAttribute CreateBendingDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
312 
313 public:
314  // ===================================================================== //
315  // Feel free to add custom code below this line, it will be preserved by
316  // the code generator.
317  //
318  // Just remember to:
319  // - Close the class declaration with };
320  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
321  // - Close the include guard with #endif
322  // ===================================================================== //
323  // --(BEGIN CUSTOM CODE)--
324 };
325 
326 PXR_NAMESPACE_CLOSE_SCOPE
327 
328 #endif
PHYSXSCHEMA_API UsdAttribute CreateBendingDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBendingDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateDynamicFrictionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDynamicFrictionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetDynamicFrictionAttr() const
Dynamic friction coefficient.
WARNING: This is a draft API; the design is not fixed and may change in the future.
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceMaterialAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateYoungsModulusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetYoungsModulusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableSurfaceMaterialAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateDensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDensityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute GetYoungsModulusAttr() const
Young's modulus, i.e.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreatePoissonsRatioAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPoissonsRatioAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxDeformableSurfaceMaterialAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on UsdPrim prim .
PhysxSchemaPhysxDeformableSurfaceMaterialAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxDeformableSurfaceMaterialAPI on the prim held by schemaObj ...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute GetDensityAttr() const
Material density.
PHYSXSCHEMA_API UsdAttribute GetThicknessAttr() const
Virtual thickness of cloth mesh.
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceMaterialAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxDeformableSurfaceMaterialAPI holding the prim adhering to this schema at pat...
PHYSXSCHEMA_API UsdAttribute GetPoissonsRatioAttr() const
Poissons's ratio which defines the material's volume preservation under stress.
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 GetBendingDampingAttr() const
Material damping parameter for bending constraints.
PHYSXSCHEMA_API UsdAttribute CreateElasticityDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetElasticityDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetElasticityDampingAttr() const
Material damping parameter.