All Classes Files Functions Variables Pages
physxDeformableSurfaceAPI.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_PHYSXDEFORMABLESURFACEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXDEFORMABLESURFACEAPI_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 // PHYSXDEFORMABLESURFACEAPI //
51 // -------------------------------------------------------------------------- //
52 
60 {
61 public:
65  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
66 
71  explicit PhysxSchemaPhysxDeformableSurfaceAPI(const UsdPrim& prim=UsdPrim())
73  {
74  }
75 
79  explicit PhysxSchemaPhysxDeformableSurfaceAPI(const UsdSchemaBase& 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  // BENDINGSTIFFNESSSCALE
149  // --------------------------------------------------------------------- //
159  PHYSXSCHEMA_API
160  UsdAttribute GetBendingStiffnessScaleAttr() const;
161 
167  PHYSXSCHEMA_API
168  UsdAttribute CreateBendingStiffnessScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
169 
170 public:
171  // ===================================================================== //
172  // Feel free to add custom code below this line, it will be preserved by
173  // the code generator.
174  //
175  // Just remember to:
176  // - Close the class declaration with };
177  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
178  // - Close the include guard with #endif
179  // ===================================================================== //
180  // --(BEGIN CUSTOM CODE)--
181 };
182 
183 PXR_NAMESPACE_CLOSE_SCOPE
184 
185 #endif
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableSurfaceAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateBendingStiffnessScaleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBendingStiffnessScaleAttr(), 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.
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 PhysxSchemaPhysxDeformableSurfaceAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxDeformableSurfaceAPI holding the prim adhering to this schema at path on sta...
PHYSXSCHEMA_API UsdAttribute GetBendingStiffnessScaleAttr() const
Scales bending stiffness computed from young's modulus and the cloth thickness.
PhysxSchemaPhysxDeformableSurfaceAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim prim .
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PhysxSchemaPhysxDeformableSurfaceAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by schemaObj .