All Classes Files Functions Variables Pages
physxParticleClothAPI.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_PHYSXPARTICLECLOTHAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPARTICLECLOTHAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include ".//physxParticleAPI.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 // PHYSXPARTICLECLOTHAPI //
51 // -------------------------------------------------------------------------- //
52 
60 {
61 public:
65  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
66 
71  explicit PhysxSchemaPhysxParticleClothAPI(const UsdPrim& prim=UsdPrim())
73  {
74  }
75 
79  explicit PhysxSchemaPhysxParticleClothAPI(const UsdSchemaBase& schemaObj)
80  : PhysxSchemaPhysxParticleAPI(schemaObj)
81  {
82  }
83 
85  PHYSXSCHEMA_API
87 
91  PHYSXSCHEMA_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  PHYSXSCHEMA_API
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
108 
123  PHYSXSCHEMA_API
125  Apply(const UsdPrim &prim);
126 
127 protected:
131  PHYSXSCHEMA_API
132  UsdSchemaType _GetSchemaType() const override;
133 
134 private:
135  // needs to invoke _GetStaticTfType.
136  friend class UsdSchemaRegistry;
137  PHYSXSCHEMA_API
138  static const TfType &_GetStaticTfType();
139 
140  static bool _IsTypedSchema();
141 
142  // override SchemaBase virtuals.
143  PHYSXSCHEMA_API
144  const TfType &_GetTfType() const override;
145 
146 public:
147  // --------------------------------------------------------------------- //
148  // SELFCOLLISIONFILTER
149  // --------------------------------------------------------------------- //
157  PHYSXSCHEMA_API
158  UsdAttribute GetSelfCollisionFilterAttr() const;
159 
165  PHYSXSCHEMA_API
166  UsdAttribute CreateSelfCollisionFilterAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // RESTPOINTS
171  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetRestPointsAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateRestPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // SPRINGINDICES
193  // --------------------------------------------------------------------- //
202  PHYSXSCHEMA_API
203  UsdAttribute GetSpringIndicesAttr() const;
204 
210  PHYSXSCHEMA_API
211  UsdAttribute CreateSpringIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // SPRINGSTIFFNESSES
216  // --------------------------------------------------------------------- //
226  PHYSXSCHEMA_API
227  UsdAttribute GetSpringStiffnessesAttr() const;
228 
234  PHYSXSCHEMA_API
235  UsdAttribute CreateSpringStiffnessesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // SPRINGDAMPINGS
240  // --------------------------------------------------------------------- //
250  PHYSXSCHEMA_API
251  UsdAttribute GetSpringDampingsAttr() const;
252 
258  PHYSXSCHEMA_API
259  UsdAttribute CreateSpringDampingsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
260 
261 public:
262  // --------------------------------------------------------------------- //
263  // SPRINGRESTLENGTHS
264  // --------------------------------------------------------------------- //
274  PHYSXSCHEMA_API
275  UsdAttribute GetSpringRestLengthsAttr() const;
276 
282  PHYSXSCHEMA_API
283  UsdAttribute CreateSpringRestLengthsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
284 
285 public:
286  // --------------------------------------------------------------------- //
287  // PRESSURE
288  // --------------------------------------------------------------------- //
300  PHYSXSCHEMA_API
301  UsdAttribute GetPressureAttr() const;
302 
308  PHYSXSCHEMA_API
309  UsdAttribute CreatePressureAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
310 
311 public:
312  // ===================================================================== //
313  // Feel free to add custom code below this line, it will be preserved by
314  // the code generator.
315  //
316  // Just remember to:
317  // - Close the class declaration with };
318  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
319  // - Close the include guard with #endif
320  // ===================================================================== //
321  // --(BEGIN CUSTOM CODE)--
322 };
323 
324 PXR_NAMESPACE_CLOSE_SCOPE
325 
326 #endif
PHYSXSCHEMA_API UsdAttribute GetSpringDampingsAttr() const
Coefficients for linear-distance dampers between a pair of particles as defined by index pairs in spr...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetSpringRestLengthsAttr() const
Spring rest lengths corresponding to spring index pairs.
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdAttribute CreateRestPointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSpringStiffnessesAttr() const
Stiffness values for linear-distance springs between a pair of particles as defined by index pairs in...
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdAttribute CreatePressureAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPressureAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleClothAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateSelfCollisionFilterAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSelfCollisionFilterAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSelfCollisionFilterAttr() const
Whether the simulation should filter particle-particle collisions based on their rest position distan...
PHYSXSCHEMA_API UsdAttribute GetRestPointsAttr() const
Particle positions in cloth rest configuration.
PHYSXSCHEMA_API UsdAttribute CreateSpringRestLengthsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSpringRestLengthsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSpringDampingsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSpringDampingsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute GetSpringIndicesAttr() const
List of index pairs describing which points are connected by spring constraints.
PhysxSchemaPhysxParticleClothAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxParticleClothAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleClothAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxParticleClothAPI holding the prim adhering to this schema at path on stage...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleClothAPI()
Destructor.
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 CreateSpringIndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSpringIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxParticleClothAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxParticleClothAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetPressureAttr() const
Pressure: If > 0, a particle cloth has an additional pressure constraint that provides inflatable (i...
PHYSXSCHEMA_API UsdAttribute CreateSpringStiffnessesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSpringStiffnessesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...