All Classes Files Functions Variables Pages
physxSDFMeshCollisionAPI.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_PHYSXSDFMESHCOLLISIONAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXSDFMESHCOLLISIONAPI_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 // PHYSXSDFMESHCOLLISIONAPI //
51 // -------------------------------------------------------------------------- //
52 
62 class PhysxSchemaPhysxSDFMeshCollisionAPI : public UsdAPISchemaBase
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
69 
74  explicit PhysxSchemaPhysxSDFMeshCollisionAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPhysxSDFMeshCollisionAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
126  PHYSXSCHEMA_API
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  PHYSXSCHEMA_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  PHYSXSCHEMA_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  PHYSXSCHEMA_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // SDFRESOLUTION
152  // --------------------------------------------------------------------- //
164  PHYSXSCHEMA_API
165  UsdAttribute GetSdfResolutionAttr() const;
166 
172  PHYSXSCHEMA_API
173  UsdAttribute CreateSdfResolutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // SDFSUBGRIDRESOLUTION
178  // --------------------------------------------------------------------- //
192  PHYSXSCHEMA_API
193  UsdAttribute GetSdfSubgridResolutionAttr() const;
194 
200  PHYSXSCHEMA_API
201  UsdAttribute CreateSdfSubgridResolutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
202 
203 public:
204  // --------------------------------------------------------------------- //
205  // SDFBITSPERSUBGRIDPIXEL
206  // --------------------------------------------------------------------- //
218  PHYSXSCHEMA_API
219  UsdAttribute GetSdfBitsPerSubgridPixelAttr() const;
220 
226  PHYSXSCHEMA_API
227  UsdAttribute CreateSdfBitsPerSubgridPixelAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
228 
229 public:
230  // --------------------------------------------------------------------- //
231  // SDFNARROWBANDTHICKNESS
232  // --------------------------------------------------------------------- //
246  PHYSXSCHEMA_API
247  UsdAttribute GetSdfNarrowBandThicknessAttr() const;
248 
254  PHYSXSCHEMA_API
255  UsdAttribute CreateSdfNarrowBandThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
256 
257 public:
258  // --------------------------------------------------------------------- //
259  // SDFMARGIN
260  // --------------------------------------------------------------------- //
274  PHYSXSCHEMA_API
275  UsdAttribute GetSdfMarginAttr() const;
276 
282  PHYSXSCHEMA_API
283  UsdAttribute CreateSdfMarginAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
284 
285 public:
286  // ===================================================================== //
287  // Feel free to add custom code below this line, it will be preserved by
288  // the code generator.
289  //
290  // Just remember to:
291  // - Close the class declaration with };
292  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
293  // - Close the include guard with #endif
294  // ===================================================================== //
295  // --(BEGIN CUSTOM CODE)--
296 };
297 
298 PXR_NAMESPACE_CLOSE_SCOPE
299 
300 #endif
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute GetSdfNarrowBandThicknessAttr() const
Size of the narrow band around the mesh surface where high resolution SDF samples are available...
PHYSXSCHEMA_API UsdAttribute CreateSdfSubgridResolutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSdfSubgridResolutionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSdfSubgridResolutionAttr() const
A positive subgrid resolution enables sparsity on signed-distance-fields (SDF) while a value of 0 lea...
PhysX SDF mesh extended parameters.
static PHYSXSCHEMA_API PhysxSchemaPhysxSDFMeshCollisionAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateSdfNarrowBandThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSdfNarrowBandThicknessAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...
PhysxSchemaPhysxSDFMeshCollisionAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxSDFMeshCollisionAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetSdfResolutionAttr() const
The spacing of the uniformly sampled SDF is equal to the largest AABB extent of the mesh...
PHYSXSCHEMA_API UsdAttribute CreateSdfMarginAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSdfMarginAttr(), 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.
PhysxSchemaPhysxSDFMeshCollisionAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxSDFMeshCollisionAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute CreateSdfResolutionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSdfResolutionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSdfBitsPerSubgridPixelAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSdfBitsPerSubgridPixelAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...
PHYSXSCHEMA_API UsdAttribute GetSdfBitsPerSubgridPixelAttr() const
Values of 8, 16 and 32 bits per subgrid pixel are supported.
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 ~PhysxSchemaPhysxSDFMeshCollisionAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetSdfMarginAttr() const
Margin to increase the size of the SDF relative to the bounding box diagonal length of the mesh...
static PHYSXSCHEMA_API PhysxSchemaPhysxSDFMeshCollisionAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxSDFMeshCollisionAPI holding the prim adhering to this schema at path on stag...