All Classes Files Functions Variables Pages
physxDeformableAPI.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_PHYSXDEFORMABLEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXDEFORMABLEAPI_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 // PHYSXDEFORMABLEAPI //
51 // -------------------------------------------------------------------------- //
52 
60 class PhysxSchemaPhysxDeformableAPI : public UsdAPISchemaBase
61 {
62 public:
66  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
67 
72  explicit PhysxSchemaPhysxDeformableAPI(const UsdPrim& prim=UsdPrim())
73  : UsdAPISchemaBase(prim)
74  {
75  }
76 
80  explicit PhysxSchemaPhysxDeformableAPI(const UsdSchemaBase& schemaObj)
81  : UsdAPISchemaBase(schemaObj)
82  {
83  }
84 
86  PHYSXSCHEMA_API
88 
92  PHYSXSCHEMA_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  PHYSXSCHEMA_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109 
124  PHYSXSCHEMA_API
126  Apply(const UsdPrim &prim);
127 
128 protected:
132  PHYSXSCHEMA_API
133  UsdSchemaType _GetSchemaType() const override;
134 
135 private:
136  // needs to invoke _GetStaticTfType.
137  friend class UsdSchemaRegistry;
138  PHYSXSCHEMA_API
139  static const TfType &_GetStaticTfType();
140 
141  static bool _IsTypedSchema();
142 
143  // override SchemaBase virtuals.
144  PHYSXSCHEMA_API
145  const TfType &_GetTfType() const override;
146 
147 public:
148  // --------------------------------------------------------------------- //
149  // DEFORMABLEENABLED
150  // --------------------------------------------------------------------- //
158  PHYSXSCHEMA_API
159  UsdAttribute GetDeformableEnabledAttr() const;
160 
166  PHYSXSCHEMA_API
167  UsdAttribute CreateDeformableEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // SOLVERPOSITIONITERATIONCOUNT
172  // --------------------------------------------------------------------- //
181  PHYSXSCHEMA_API
182  UsdAttribute GetSolverPositionIterationCountAttr() const;
183 
189  PHYSXSCHEMA_API
190  UsdAttribute CreateSolverPositionIterationCountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
191 
192 public:
193  // --------------------------------------------------------------------- //
194  // VERTEXVELOCITYDAMPING
195  // --------------------------------------------------------------------- //
205  PHYSXSCHEMA_API
206  UsdAttribute GetVertexVelocityDampingAttr() const;
207 
213  PHYSXSCHEMA_API
214  UsdAttribute CreateVertexVelocityDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
215 
216 public:
217  // --------------------------------------------------------------------- //
218  // SLEEPDAMPING
219  // --------------------------------------------------------------------- //
229  PHYSXSCHEMA_API
230  UsdAttribute GetSleepDampingAttr() const;
231 
237  PHYSXSCHEMA_API
238  UsdAttribute CreateSleepDampingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
239 
240 public:
241  // --------------------------------------------------------------------- //
242  // SLEEPTHRESHOLD
243  // --------------------------------------------------------------------- //
253  PHYSXSCHEMA_API
254  UsdAttribute GetSleepThresholdAttr() const;
255 
261  PHYSXSCHEMA_API
262  UsdAttribute CreateSleepThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
263 
264 public:
265  // --------------------------------------------------------------------- //
266  // SETTLINGTHRESHOLD
267  // --------------------------------------------------------------------- //
277  PHYSXSCHEMA_API
278  UsdAttribute GetSettlingThresholdAttr() const;
279 
285  PHYSXSCHEMA_API
286  UsdAttribute CreateSettlingThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
287 
288 public:
289  // --------------------------------------------------------------------- //
290  // SELFCOLLISION
291  // --------------------------------------------------------------------- //
299  PHYSXSCHEMA_API
300  UsdAttribute GetSelfCollisionAttr() const;
301 
307  PHYSXSCHEMA_API
308  UsdAttribute CreateSelfCollisionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
309 
310 public:
311  // --------------------------------------------------------------------- //
312  // SELFCOLLISIONFILTERDISTANCE
313  // --------------------------------------------------------------------- //
323  PHYSXSCHEMA_API
324  UsdAttribute GetSelfCollisionFilterDistanceAttr() const;
325 
331  PHYSXSCHEMA_API
332  UsdAttribute CreateSelfCollisionFilterDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
333 
334 public:
335  // --------------------------------------------------------------------- //
336  // ENABLECCD
337  // --------------------------------------------------------------------- //
345  PHYSXSCHEMA_API
346  UsdAttribute GetEnableCCDAttr() const;
347 
353  PHYSXSCHEMA_API
354  UsdAttribute CreateEnableCCDAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
355 
356 public:
357  // --------------------------------------------------------------------- //
358  // RESTPOINTS
359  // --------------------------------------------------------------------- //
368  PHYSXSCHEMA_API
369  UsdAttribute GetRestPointsAttr() const;
370 
376  PHYSXSCHEMA_API
377  UsdAttribute CreateRestPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
378 
379 public:
380  // --------------------------------------------------------------------- //
381  // SIMULATIONVELOCITIES
382  // --------------------------------------------------------------------- //
391  PHYSXSCHEMA_API
392  UsdAttribute GetSimulationVelocitiesAttr() const;
393 
399  PHYSXSCHEMA_API
400  UsdAttribute CreateSimulationVelocitiesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
401 
402 public:
403  // --------------------------------------------------------------------- //
404  // SIMULATIONINDICES
405  // --------------------------------------------------------------------- //
414  PHYSXSCHEMA_API
415  UsdAttribute GetSimulationIndicesAttr() const;
416 
422  PHYSXSCHEMA_API
423  UsdAttribute CreateSimulationIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
424 
425 public:
426  // --------------------------------------------------------------------- //
427  // SIMULATIONOWNER
428  // --------------------------------------------------------------------- //
432  PHYSXSCHEMA_API
433  UsdRelationship GetSimulationOwnerRel() const;
434 
437  PHYSXSCHEMA_API
438  UsdRelationship CreateSimulationOwnerRel() const;
439 
440 public:
441  // ===================================================================== //
442  // Feel free to add custom code below this line, it will be preserved by
443  // the code generator.
444  //
445  // Just remember to:
446  // - Close the class declaration with };
447  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
448  // - Close the include guard with #endif
449  // ===================================================================== //
450  // --(BEGIN CUSTOM CODE)--
451 };
452 
453 PXR_NAMESPACE_CLOSE_SCOPE
454 
455 #endif
PHYSXSCHEMA_API UsdAttribute CreateDeformableEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDeformableEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetRestPointsAttr() const
Rest points of the UsdGeomMesh in local coordinates.
PHYSXSCHEMA_API UsdAttribute CreateSelfCollisionFilterDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSelfCollisionFilterDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs ...
PhysxSchemaPhysxDeformableAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxDeformableAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetSleepDampingAttr() const
Additional damping term if vertex velocity drops below settlingThreshold.
PHYSXSCHEMA_API UsdAttribute GetSelfCollisionAttr() const
Enables self collisions on the deformable, preventing self intersections.
PHYSXSCHEMA_API UsdAttribute CreateSimulationIndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSimulationIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSleepDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSleepDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetDeformableEnabledAttr() const
Enable or disable the deformable object.
PHYSXSCHEMA_API UsdAttribute GetVertexVelocityDampingAttr() const
Artificial damping on the vertex velocity, which may approximate aerodynamic drag.
PHYSXSCHEMA_API UsdAttribute GetSimulationIndicesAttr() const
Simulation mesh indices.
PHYSXSCHEMA_API UsdAttribute CreateEnableCCDAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableCCDAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship CreateSimulationOwnerRel() const
See GetSimulationOwnerRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetSimulationVelocitiesAttr() const
Simulation mesh vertex velocities in local coordinates.
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 GetSolverPositionIterationCountAttr() const
Number of solver position iterations per time step.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableAPI()
Destructor.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateSelfCollisionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSelfCollisionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSleepThresholdAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSleepThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSettlingThresholdAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSettlingThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetEnableCCDAttr() const
Distance based CCD.
PHYSXSCHEMA_API UsdAttribute CreateSimulationVelocitiesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSimulationVelocitiesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateVertexVelocityDampingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVertexVelocityDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSleepThresholdAttr() const
Velocity threshold under which the vertex becomes a candidate for sleeping.
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...
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxDeformableAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdRelationship GetSimulationOwnerRel() const
Single PhysicsScene that simulates this deformable.
PhysxSchemaPhysxDeformableAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxDeformableAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute GetSettlingThresholdAttr() const
Threshold vertex velocity under which sleep damping is applied in addition to velocity damping...
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateSolverPositionIterationCountAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSolverPositionIterationCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...
PHYSXSCHEMA_API UsdAttribute GetSelfCollisionFilterDistanceAttr() const
Distance under which self-collisions are disabled.