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 
58 class PhysxSchemaPhysxAutoAttachmentAPI : public UsdAPISchemaBase
59 {
60 public:
64  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
65 
70  explicit PhysxSchemaPhysxAutoAttachmentAPI(const UsdPrim& prim=UsdPrim())
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
78  explicit PhysxSchemaPhysxAutoAttachmentAPI(const UsdSchemaBase& schemaObj)
79  : UsdAPISchemaBase(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 
124  PHYSXSCHEMA_API
125  static bool
126  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
127 
143  PHYSXSCHEMA_API
145  Apply(const UsdPrim &prim);
146 
147 protected:
151  PHYSXSCHEMA_API
152  UsdSchemaKind _GetSchemaKind() const override;
153 
154 private:
155  // needs to invoke _GetStaticTfType.
156  friend class UsdSchemaRegistry;
157  PHYSXSCHEMA_API
158  static const TfType &_GetStaticTfType();
159 
160  static bool _IsTypedSchema();
161 
162  // override SchemaBase virtuals.
163  PHYSXSCHEMA_API
164  const TfType &_GetTfType() const override;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // ENABLEDEFORMABLEVERTEXATTACHMENTS
169  // --------------------------------------------------------------------- //
178  PHYSXSCHEMA_API
179  UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const;
180 
186  PHYSXSCHEMA_API
187  UsdAttribute CreateEnableDeformableVertexAttachmentsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // DEFORMABLEVERTEXOVERLAPOFFSET
192  // --------------------------------------------------------------------- //
203  PHYSXSCHEMA_API
204  UsdAttribute GetDeformableVertexOverlapOffsetAttr() const;
205 
211  PHYSXSCHEMA_API
212  UsdAttribute CreateDeformableVertexOverlapOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // ENABLERIGIDSURFACEATTACHMENTS
217  // --------------------------------------------------------------------- //
226  PHYSXSCHEMA_API
227  UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const;
228 
234  PHYSXSCHEMA_API
235  UsdAttribute CreateEnableRigidSurfaceAttachmentsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // RIGIDSURFACESAMPLINGDISTANCE
240  // --------------------------------------------------------------------- //
251  PHYSXSCHEMA_API
252  UsdAttribute GetRigidSurfaceSamplingDistanceAttr() const;
253 
259  PHYSXSCHEMA_API
260  UsdAttribute CreateRigidSurfaceSamplingDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
261 
262 public:
263  // --------------------------------------------------------------------- //
264  // ENABLECOLLISIONFILTERING
265  // --------------------------------------------------------------------- //
274  PHYSXSCHEMA_API
275  UsdAttribute GetEnableCollisionFilteringAttr() const;
276 
282  PHYSXSCHEMA_API
283  UsdAttribute CreateEnableCollisionFilteringAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
284 
285 public:
286  // --------------------------------------------------------------------- //
287  // COLLISIONFILTERINGOFFSET
288  // --------------------------------------------------------------------- //
299  PHYSXSCHEMA_API
300  UsdAttribute GetCollisionFilteringOffsetAttr() const;
301 
307  PHYSXSCHEMA_API
308  UsdAttribute CreateCollisionFilteringOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
309 
310 public:
311  // --------------------------------------------------------------------- //
312  // ENABLEDEFORMABLEFILTERINGPAIRS
313  // --------------------------------------------------------------------- //
323  PHYSXSCHEMA_API
324  UsdAttribute GetEnableDeformableFilteringPairsAttr() const;
325 
331  PHYSXSCHEMA_API
332  UsdAttribute CreateEnableDeformableFilteringPairsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
333 
334 public:
335  // ===================================================================== //
336  // Feel free to add custom code below this line, it will be preserved by
337  // the code generator.
338  //
339  // Just remember to:
340  // - Close the class declaration with };
341  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
342  // - Close the include guard with #endif
343  // ===================================================================== //
344  // --(BEGIN CUSTOM CODE)--
345 };
346 
347 PXR_NAMESPACE_CLOSE_SCOPE
348 
349 #endif
Deprecated: Will be replaced by a new deformable schema in a future release.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxAutoAttachmentAPI()
Destructor.
static PHYSXSCHEMA_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
PHYSXSCHEMA_API UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
PhysxSchemaPhysxAutoAttachmentAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxAutoAttachmentAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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
Deprecated: Will be replaced by a new deformable schema in a future release.
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
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetEnableCollisionFilteringAttr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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...
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
Deprecated: Will be replaced by a new deformable schema in a future release.
PHYSXSCHEMA_API UsdAttribute GetEnableDeformableFilteringPairsAttr() const
Deprecated: Will be replaced by a new deformable schema in a future release.
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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.