All Classes Files Functions Variables Pages
physxConvexDecompositionCollisionAPI.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_PHYSXCONVEXDECOMPOSITIONCOLLISIONAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXCONVEXDECOMPOSITIONCOLLISIONAPI_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 // PHYSXCONVEXDECOMPOSITIONCOLLISIONAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxConvexDecompositionCollisionAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxConvexDecompositionCollisionAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxConvexDecompositionCollisionAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
121  PHYSXSCHEMA_API
123  Apply(const UsdPrim &prim);
124 
125 protected:
129  PHYSXSCHEMA_API
130  UsdSchemaType _GetSchemaType() const override;
131 
132 private:
133  // needs to invoke _GetStaticTfType.
134  friend class UsdSchemaRegistry;
135  PHYSXSCHEMA_API
136  static const TfType &_GetStaticTfType();
137 
138  static bool _IsTypedSchema();
139 
140  // override SchemaBase virtuals.
141  PHYSXSCHEMA_API
142  const TfType &_GetTfType() const override;
143 
144 public:
145  // --------------------------------------------------------------------- //
146  // HULLVERTEXLIMIT
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetHullVertexLimitAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateHullVertexLimitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // MAXCONVEXHULLS
169  // --------------------------------------------------------------------- //
177  PHYSXSCHEMA_API
178  UsdAttribute GetMaxConvexHullsAttr() const;
179 
185  PHYSXSCHEMA_API
186  UsdAttribute CreateMaxConvexHullsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187 
188 public:
189  // --------------------------------------------------------------------- //
190  // MINTHICKNESS
191  // --------------------------------------------------------------------- //
201  PHYSXSCHEMA_API
202  UsdAttribute GetMinThicknessAttr() const;
203 
209  PHYSXSCHEMA_API
210  UsdAttribute CreateMinThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211 
212 public:
213  // --------------------------------------------------------------------- //
214  // VOXELRESOLUTION
215  // --------------------------------------------------------------------- //
223  PHYSXSCHEMA_API
224  UsdAttribute GetVoxelResolutionAttr() const;
225 
231  PHYSXSCHEMA_API
232  UsdAttribute CreateVoxelResolutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // ERRORPERCENTAGE
237  // --------------------------------------------------------------------- //
245  PHYSXSCHEMA_API
246  UsdAttribute GetErrorPercentageAttr() const;
247 
253  PHYSXSCHEMA_API
254  UsdAttribute CreateErrorPercentageAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
255 
256 public:
257  // --------------------------------------------------------------------- //
258  // SHRINKWRAP
259  // --------------------------------------------------------------------- //
267  PHYSXSCHEMA_API
268  UsdAttribute GetShrinkWrapAttr() const;
269 
275  PHYSXSCHEMA_API
276  UsdAttribute CreateShrinkWrapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
277 
278 public:
279  // ===================================================================== //
280  // Feel free to add custom code below this line, it will be preserved by
281  // the code generator.
282  //
283  // Just remember to:
284  // - Close the class declaration with };
285  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
286  // - Close the include guard with #endif
287  // ===================================================================== //
288  // --(BEGIN CUSTOM CODE)--
289 };
290 
291 PXR_NAMESPACE_CLOSE_SCOPE
292 
293 #endif
PHYSXSCHEMA_API UsdAttribute GetVoxelResolutionAttr() const
Voxel resolution used for convex decomposition.
PHYSXSCHEMA_API UsdAttribute GetMinThicknessAttr() const
Convex hull min thickness.
PHYSXSCHEMA_API UsdAttribute CreateErrorPercentageAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetErrorPercentageAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateHullVertexLimitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHullVertexLimitAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetErrorPercentageAttr() const
Convex decomposition errorPercentage parameter.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxConvexDecompositionCollisionAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetShrinkWrapAttr() const
Attempts to adjust the convex hull points so that they are projected onto the surface of the original...
PHYSXSCHEMA_API UsdAttribute CreateMaxConvexHullsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxConvexHullsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysX convex decomposition extended parameters.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateShrinkWrapAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShrinkWrapAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxConvexDecompositionCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetHullVertexLimitAttr() const
Convex hull vertex limit used for convex hull cooking.
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 CreateVoxelResolutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVoxelResolutionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxConvexDecompositionCollisionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxConvexDecompositionCollisionAPI holding the prim adhering to this schema at ...
PHYSXSCHEMA_API UsdAttribute CreateMinThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetMaxConvexHullsAttr() const
Maximum of convex hulls created during convex decomposition.
static PHYSXSCHEMA_API PhysxSchemaPhysxConvexDecompositionCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PhysxSchemaPhysxConvexDecompositionCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxConvexDecompositionCollisionAPI on the prim held by schemaObj ...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.