All Classes Files Functions Variables Pages
physxDeformableBodyAPI.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_PHYSXDEFORMABLEBODYAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXDEFORMABLEBODYAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include ".//physxDeformableAPI.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 // PHYSXDEFORMABLEBODYAPI //
51 // -------------------------------------------------------------------------- //
52 
59 {
60 public:
64  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
65 
70  explicit PhysxSchemaPhysxDeformableBodyAPI(const UsdPrim& prim=UsdPrim())
72  {
73  }
74 
78  explicit PhysxSchemaPhysxDeformableBodyAPI(const UsdSchemaBase& 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  // DISABLEGRAVITY
148  // --------------------------------------------------------------------- //
156  PHYSXSCHEMA_API
157  UsdAttribute GetDisableGravityAttr() const;
158 
164  PHYSXSCHEMA_API
165  UsdAttribute CreateDisableGravityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // COLLISIONINDICES
170  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetCollisionIndicesAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateCollisionIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // COLLISIONPOINTS
193  // --------------------------------------------------------------------- //
202  PHYSXSCHEMA_API
203  UsdAttribute GetCollisionPointsAttr() const;
204 
210  PHYSXSCHEMA_API
211  UsdAttribute CreateCollisionPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // COLLISIONRESTPOINTS
216  // --------------------------------------------------------------------- //
224  PHYSXSCHEMA_API
225  UsdAttribute GetCollisionRestPointsAttr() const;
226 
232  PHYSXSCHEMA_API
233  UsdAttribute CreateCollisionRestPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
234 
235 public:
236  // --------------------------------------------------------------------- //
237  // SIMULATIONPOINTS
238  // --------------------------------------------------------------------- //
247  PHYSXSCHEMA_API
248  UsdAttribute GetSimulationPointsAttr() const;
249 
255  PHYSXSCHEMA_API
256  UsdAttribute CreateSimulationPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257 
258 public:
259  // --------------------------------------------------------------------- //
260  // SIMULATIONRESTPOINTS
261  // --------------------------------------------------------------------- //
269  PHYSXSCHEMA_API
270  UsdAttribute GetSimulationRestPointsAttr() const;
271 
277  PHYSXSCHEMA_API
278  UsdAttribute CreateSimulationRestPointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
279 
280 public:
281  // ===================================================================== //
282  // Feel free to add custom code below this line, it will be preserved by
283  // the code generator.
284  //
285  // Just remember to:
286  // - Close the class declaration with };
287  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
288  // - Close the include guard with #endif
289  // ===================================================================== //
290  // --(BEGIN CUSTOM CODE)--
291 };
292 
293 PXR_NAMESPACE_CLOSE_SCOPE
294 
295 #endif
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxDeformableBodyAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute GetDisableGravityAttr() const
Disable gravity for the actor.
PHYSXSCHEMA_API UsdAttribute CreateCollisionIndicesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionIndicesAttr(), 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.
Applied to a UsdGeomMesh that is to be driven by a deformable body simulation.
PHYSXSCHEMA_API UsdAttribute CreateCollisionRestPointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionRestPointsAttr(), 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 CreateDisableGravityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDisableGravityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetCollisionRestPointsAttr() const
Mesh rest points in local coordinates that define the rest pose of the collision tetrahedral mesh tog...
PHYSXSCHEMA_API UsdAttribute GetCollisionPointsAttr() const
Mesh points in local coordinates that define the collision tetrahedral mesh together with the collisi...
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...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableBodyAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateCollisionPointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxDeformableBodyAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxDeformableBodyAPI on the prim held by schemaObj .
PhysxSchemaPhysxDeformableBodyAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxDeformableBodyAPI on UsdPrim prim .
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableBodyAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateSimulationPointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSimulationPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSimulationRestPointsAttr() const
Mesh rest points in local coordinates that define the rest pose of the simulation tetrahedral mesh to...
PHYSXSCHEMA_API UsdAttribute CreateSimulationRestPointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSimulationRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSimulationPointsAttr() const
Simulation mesh points in local coordinates that define the simulation tetrahedral mesh together with...
PHYSXSCHEMA_API UsdAttribute GetCollisionIndicesAttr() const
Mesh indices that define the collision tetrahedral mesh together with the collisionPoints attribute...