All Classes Files Functions Variables Pages
physxAutoAttachmentAPI.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_PHYSXAUTOATTACHMENTAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXAUTOATTACHMENTAPI_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 // PHYSXAUTOATTACHMENTAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxAutoAttachmentAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxAutoAttachmentAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxAutoAttachmentAPI(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  // ENABLEDEFORMABLEVERTEXATTACHMENTS
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateEnableDeformableVertexAttachmentsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // DEFORMABLEVERTEXOVERLAPOFFSET
169  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetDeformableVertexOverlapOffsetAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateDeformableVertexOverlapOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // ENABLERIGIDSURFACEATTACHMENTS
193  // --------------------------------------------------------------------- //
201  PHYSXSCHEMA_API
202  UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const;
203 
209  PHYSXSCHEMA_API
210  UsdAttribute CreateEnableRigidSurfaceAttachmentsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211 
212 public:
213  // --------------------------------------------------------------------- //
214  // RIGIDSURFACESAMPLINGDISTANCE
215  // --------------------------------------------------------------------- //
225  PHYSXSCHEMA_API
226  UsdAttribute GetRigidSurfaceSamplingDistanceAttr() const;
227 
233  PHYSXSCHEMA_API
234  UsdAttribute CreateRigidSurfaceSamplingDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
235 
236 public:
237  // --------------------------------------------------------------------- //
238  // ENABLECOLLISIONFILTERING
239  // --------------------------------------------------------------------- //
247  PHYSXSCHEMA_API
248  UsdAttribute GetEnableCollisionFilteringAttr() const;
249 
255  PHYSXSCHEMA_API
256  UsdAttribute CreateEnableCollisionFilteringAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257 
258 public:
259  // --------------------------------------------------------------------- //
260  // COLLISIONFILTERINGOFFSET
261  // --------------------------------------------------------------------- //
271  PHYSXSCHEMA_API
272  UsdAttribute GetCollisionFilteringOffsetAttr() const;
273 
279  PHYSXSCHEMA_API
280  UsdAttribute CreateCollisionFilteringOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
281 
282 public:
283  // --------------------------------------------------------------------- //
284  // ENABLEDEFORMABLEFILTERINGPAIRS
285  // --------------------------------------------------------------------- //
294  PHYSXSCHEMA_API
295  UsdAttribute GetEnableDeformableFilteringPairsAttr() const;
296 
302  PHYSXSCHEMA_API
303  UsdAttribute CreateEnableDeformableFilteringPairsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
304 
305 public:
306  // ===================================================================== //
307  // Feel free to add custom code below this line, it will be preserved by
308  // the code generator.
309  //
310  // Just remember to:
311  // - Close the class declaration with };
312  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
313  // - Close the include guard with #endif
314  // ===================================================================== //
315  // --(BEGIN CUSTOM CODE)--
316 };
317 
318 PXR_NAMESPACE_CLOSE_SCOPE
319 
320 #endif
Auto generates the attachment points and filtering ids based on the attributes defined in the API...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxAutoAttachmentAPI()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const
Enables sampling attachment points on the rigid actor's surface.
PhysxSchemaPhysxAutoAttachmentAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxAutoAttachmentAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateEnableDeformableFilteringPairsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableDeformableFilteringPairsAttr(), and also Usd_Create_Or_Get_Property for when to use Get ...
PHYSXSCHEMA_API UsdAttribute CreateEnableCollisionFilteringAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableCollisionFilteringAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cre...
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 GetDeformableVertexOverlapOffsetAttr() const
Deformable mesh vertices are attached if their distance to the other actor's volume is smaller than t...
PHYSXSCHEMA_API UsdAttribute CreateEnableDeformableVertexAttachmentsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableDeformableVertexAttachmentsAttr(), and also Usd_Create_Or_Get_Property for when to use G...
PHYSXSCHEMA_API UsdAttribute GetRigidSurfaceSamplingDistanceAttr() const
Attachment points on the rigid surface are positioned such that their typical neighbor distance match...
PHYSXSCHEMA_API UsdAttribute GetEnableCollisionFilteringAttr() const
Enables adding collision filtering in the vicinity of the attachment points.
PHYSXSCHEMA_API UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const
Enables attaching deformable mesh vertices which overlap with the other actor's volume.
PhysxSchemaPhysxAutoAttachmentAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxAutoAttachmentAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute CreateEnableRigidSurfaceAttachmentsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableRigidSurfaceAttachmentsAttr(), and also Usd_Create_Or_Get_Property for when to use Get v...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static PHYSXSCHEMA_API PhysxSchemaPhysxAutoAttachmentAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateCollisionFilteringOffsetAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionFilteringOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cre...
PHYSXSCHEMA_API UsdAttribute CreateDeformableVertexOverlapOffsetAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDeformableVertexOverlapOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get v...
PHYSXSCHEMA_API UsdAttribute GetCollisionFilteringOffsetAttr() const
Filering ids are generated for deformable mesh vertices if their distance to the other actor's volume...
PHYSXSCHEMA_API UsdAttribute GetEnableDeformableFilteringPairsAttr() const
Enables geometry pair based collision filtering for deformable-deformable attachments.
static PHYSXSCHEMA_API PhysxSchemaPhysxAutoAttachmentAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxAutoAttachmentAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute CreateRigidSurfaceSamplingDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRigidSurfaceSamplingDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...